天天看點

雲服務總線API管理子產品功能梳理

随着技術的不斷發展,系統間的互動越來越依賴API,使用者可以根據服務接口資訊深入了解所需要的産品,這樣不僅可以使大衆快速了解産品作用,也可以進行更廣泛的推廣。

ESB中API管理子產品下API服務接口功能可以注冊、導入、配置服務,支援新增、添加接口,為了友善外部檢視通路,需要對外提供查詢服務清單、查詢服務配置、查詢接口配置三種接口,API安全可以對服務接口和流程配置安全報警政策,發送報警資訊等。 

1總體介紹 

本文檔是介紹SMC控制台中API管理子產品,對其子產品中的功能進行梳理,友善快速了解API管理子產品中的功能。 

1.1體系結構 

ESB對API的支援主要展現在API管理、API安全和API內建,其中API管理又細分為API劃分、建立和監控。 

雲服務總線API管理子產品功能梳理

與一般的API管理不同的是,公司的API是基于ESB平台管理的,是以在管理功能上會受到ESB一定程度的影響。 

1.2基礎理念 

API的本質是應用程式程式設計接口,目的是保障系統間的互動功能,在這方面公司也有所考慮,通過對ESB平台來實作API網關的注冊及管理,這樣就可以複用ESB的內建功能,保障API的系統對接功能。 

雲服務總線API管理子產品功能梳理

API管理的核心功能包含API生命周期管理、API版本管理、API安全管理,其他輔助功能有API運作監控、調用記錄、參數統計等,公司的API管理包括API接入、API注冊、API調用。API的版本管理是通過API的路徑和版本記錄來實作的,API安全支援不同類型的認證方式、黑白名單等。 

1.3功能說明 

API管理子產品中的功能,基礎功能有應用管理、API分組、API服務以及API代理,安全預警方面有API标簽、API安全,還有API超市子產品。 

雲服務總線API管理子產品功能梳理

應用管理可以進行應用配置和安全管理,API服務管理可以對注冊服務、配置服務、代理服務進行操作,配置接口等;API安全管理可以對流程或接口配置安全報警機制,API代理可以對注冊服務進行代理,API标簽中有微信、短信、郵件。API超市分為三類API分組查詢、API應用查詢、API調用查詢。 

2基礎功能 

下面對API管理中的應用管理、API分組、API服務、API代理等子產品功能進行介紹說明。 

2.1應用管理 

應用管理子產品:支援新增、編輯、複制、檢視、删除操作,可以根據系統編碼和系統名稱進行查詢,其功能是對各個應用系統進行管理。清單頁面如下: 

雲服務總線API管理子產品功能梳理

表單頁面有生成密鑰功能,可以生成公鑰和私鑰,進行加密和解密,具體表單頁面如下: 

雲服務總線API管理子產品功能梳理

安全管理支援權限管理,可以根據标準角色、實際角色、使用者清單和群組清單來授權。 

雲服務總線API管理子產品功能梳理

2.2API分組 

API分組:支援新增、編輯、遷移、删除分組等操作,對服務進行分組管理。清單頁面如圖所示: 

雲服務總線API管理子產品功能梳理

安全管理支援權限管理,可以根據标準角色、實際角色、使用者清單和群組清單來配置設定權限。 

雲服務總線API管理子產品功能梳理

2.3API服務 

API服務:支援導入、注冊、配置、編輯、複制、啟用、禁用、釋出、反釋出、遷移、删除、導入、導出等功能,對服務進行管理。頁面如圖所示: 

雲服務總線API管理子產品功能梳理

API服務功能是将各個系統服務在ESB進行管理的功能,管理的方式包括導入、注冊和配置。 

導入:點選“導入”,彈出選擇清單,可以選擇ESB開發的服務,點選選擇即可新增服務: 

雲服務總線API管理子產品功能梳理

注冊:點選“注冊”進入注冊頁面,在頁面内輸入其他業務系統提供的服務位址。點選“解析”後,将服務的具體操作解析出來,同時自動完成儲存工作。添加服務與應用系統建立關聯,應用系統顯示的清單在應用管理裡進行配置: 

雲服務總線API管理子產品功能梳理

配置:配置頁面,可以添加編碼、名稱後配置一個服務: 

雲服務總線API管理子產品功能梳理

注意:在API服務中新增配置服務後,服務中無接口需要手動添加接口。可以根據需求新增單個接口或批量新增多個接口。 

雲服務總線API管理子產品功能梳理
雲服務總線API管理子產品功能梳理

API清單頁面如下,支援添加(注冊、REST、無法解析的服務)、新增(配置的服務)、編輯、檢視、删除操作,對服務接口進行管理: 

雲服務總線API管理子產品功能梳理

接口基本資訊頁面如下,支援設定Headers、檢視安全操作: 

雲服務總線API管理子產品功能梳理

入參出參設定頁面如下,支援插入樣例解析、新增、編輯、删除操作: 

雲服務總線API管理子產品功能梳理

插入模闆(入參、出參)頁面,支援解析回顯到設定(入參、出參)頁面: 

JOSN格式: 

雲服務總線API管理子產品功能梳理

XML格式: 

雲服務總線API管理子產品功能梳理

PathParam格式: 

雲服務總線API管理子產品功能梳理

攔截器配置清單頁面如下,支援新增、編輯、複制、檢視、删除操作,對攔截器進行管理: 

雲服務總線API管理子產品功能梳理

攔截器配置表單頁面如下: 

雲服務總線API管理子產品功能梳理

點選新增,攔截器配置頁面如下: 

雲服務總線API管理子產品功能梳理

2.4API代理 

API代理:支援添加、編輯、複制、檢視、重新整理、檢視注冊、代理版本、遷移、禁用操作,對代理的服務進行管理。清單頁面如下: 

雲服務總線API管理子產品功能梳理

表單頁面如下,跳轉到API服務代理資訊頁面: 

雲服務總線API管理子產品功能梳理

注意:服務中隻有注冊服務和配置服務可以進行代理操作,導入服務是内置服務,無法進行代理。 

雲服務總線API管理子產品功能梳理

導入服務中是否代理按鍵為灰色,無法進行選擇。 

雲服務總線API管理子產品功能梳理

3安全預警 

下面關于API管理子產品中與安全、報警相關的配置進行注意事項說明,加深對于子產品功能的了解。 

3.1API标簽 

API标簽:支援新增、編輯、遷移、删除标簽樹操作,對服務的安全報警進行管理。清單頁面如圖所示: 

雲服務總線API管理子產品功能梳理

安全管理支援權限管理,可以根據标準角色、實際角色、使用者清單和群組清單來配置設定權限。 

雲服務總線API管理子產品功能梳理

3.2API安全 

API安全:支援編輯、檢視、重新整理操作,對服務進行安全管理。清單頁面如下: 

雲服務總線API管理子產品功能梳理

表單頁面如下,支援調用系統選擇、通路上限、認證方式選擇、IP限定白名單、黑名單: 

雲服務總線API管理子產品功能梳理

報警設定頁面如下,支援重試、報警、失敗報警政策管理: 

雲服務總線API管理子產品功能梳理

點選“配置”按鈕,接口配置頁面如下: 

雲服務總線API管理子產品功能梳理

3.3報警說明 

對于配置完報警服務進行驗證報警發送消息時,需要注意在系統資源下的共享資源配置中發送郵箱。 

雲服務總線API管理子產品功能梳理

在屬性配置中的全局變量配置接收郵箱,確定可以接收郵件,配置如圖所示: 

雲服務總線API管理子產品功能梳理

4API超市 

下面對API超市中的API分組查詢、API應用查詢和API調用查詢三個子產品進行頁面和功能介紹。 

4.1分組查詢 

API分組查詢,以API分組方式對服務接口進行歸類,清單頁面如下: 

雲服務總線API管理子產品功能梳理

點選一條可以檢視基本資訊頁面,顯示服務接口資訊: 

雲服務總線API管理子產品功能梳理

HTTP調用界面,顯示服務和接口資訊,可以進行調用操作: 

雲服務總線API管理子產品功能梳理

CURL調用頁面,顯示接口資訊,支援調用: 

雲服務總線API管理子產品功能梳理

JAVA調用頁面,顯示代碼資訊,支援複制代碼、下載下傳工程、調用: 

雲服務總線API管理子產品功能梳理

4.2應用查詢 

API應用查詢,以應用系統方式對服務接口進行歸類,清單頁面如下: 

雲服務總線API管理子產品功能梳理

點選一條可以檢視基本資訊頁面,顯示服務接口資訊,同樣可以進行三種方式的調用HTTP調用、CURL調用、JAVA調用: 

雲服務總線API管理子產品功能梳理

4.3調用查詢 

API調用查詢,需要在API安全中的接口配置調用系統,才能在API調用查詢看到服務接口,清單頁面如下: 

雲服務總線API管理子產品功能梳理
雲服務總線API管理子產品功能梳理

點選一條可以檢視基本資訊頁面,顯示服務接口資訊,同樣可以進行三種方式的調用,HTTP調用、CURL調用、JAVA調用: 

雲服務總線API管理子產品功能梳理

5歸納總結 

下面主要對本次工作中的個人收獲,能力提升進行總結,對于此次工作工程中的心得體會進行說明。 

5.1知識收獲 

通過本次工作也學到了許多,對于API管理中的各個子產品功能有了進一步了解,學習了管理控制台中對于接口參數的配置,服務安全報警的觸發機制。對于API管理子產品功能的梳理核心,目的是串聯ESB各個子產品的功能,驗證多樣應用場景,為後續項目中能夠快速建立使用打下基礎。 

5.2能力提升 

5.3心得體會 

繼續閱讀