988      財經資訊

發布服務__使用說明_用戶手冊_雲服務總線 CSB-阿裏雲

發布API服務就是把一個已有的後端服務在某個CSB實例上注冊，並以選定的一種或多種協議開放成API供消費者使用，同時對服務的消費做一定的訪問控製。即包含如下三個關鍵概念：

1. 接入服務：提供API對應的後端服務信息，讓CSB能訪問到這個已有的服務
2. 開放服務：指明API開放的協議，以及開放的接口和後端服務接口如何對應
3. 訪問控製：指明API開放的策略，是否限流，對誰可見，訪問是否需要授權

1. 創建API分組

發布API必須指定歸屬API組（服務組），如果當前用戶還沒有任何API組，控製台會引導用戶轉到我的服務組頁麵創建API分組。

API組是業務上的原子粒度分組，每一個API都歸屬且僅歸屬一個API組。用戶可以創建多個API組，每個API組都應提供負責人信息，可以上傳一個服務接口定義文件，以方便發布服務時直接從這個接口定義文件選擇接口方法自動生成入參出參列表。

上傳的接口定義文件需要以jar方式提供，包含定義API所用的接口類以及所有依賴的參數類。在這個jar文件中還要提供一個接口聲明列表文件META-INF/api.list。內容格式如下麵的示例：

# 包含2個服務接口 ServiceInterfaceC 和ServiceInterfaceD
a.b.c.ServiceInterfaceC
a.b.d.ServiceInterfaceD
# 注釋掉的服務接口
#a.b.e.ServiceInterfaceE

注意：上傳的jar包編譯TARGET版本必須為1.7或以下版本。

2. 命名服務

發布API首先要確定服務的全名和別名。別名隨意，但全名在CSB群組上是唯一的，在注銷服務後可以複用。發布API還需要指定所歸屬的服務組（API組），在API數量少時API組可視作簡單分類。服務說明信息是可選的，可以填寫API的詳細描述或者其它說明信息。

服務版本說明

• CSB發布服務時指定的版本信息是該服務的CSB發布版本，與現有服務本身版本無關，不會在CSB訪問後端服務時使用該信息。
• CSB服務版本指的是該API在CSB上的定義版本。
• 同名的API可以多個不同版本的定義，可以指定某個版本為當前激活的狀態。
• CSB目前不並支持多個版本同時激活，目前隻有以特定協議（如HTTP API）調用該API時需要明確指明調用的API版本。

3. 選擇協議

現在需要提供要接入的已有後端服務的協議，並確定以什麼協議開放成API。開放的協議可以多選，針對不同的接入協議類型，CSB支持的可開放協議類型是有限製的。不同的接入協議類型，CSB需要的服務接入信息也不同。目的很簡單，就是讓CSB可以訪問要接入的已有後端服務。

4. 設定參數

在參數設置中，除了一條一條地錄入，後端服務的入參和出參列表可以通過之前在API組（服務組）中上傳的接口定義文件中選擇對應的接口和方法來生成，然後再做適當修改。

每一個入參都可以選擇是否在API中開放，如果不開放但又是後端服務必要的入參，需要指定缺省值。參數的編輯支持平級插入（向下的三角箭頭）和縮進插入（向右的三角箭頭），也支持數組、列表、集合等類型，可以定義複雜的多級結構。

可以輸入服務自己的錯誤代碼列表，給服務的使用者參考。還可以指定服務的模擬返回結果，當用戶以模擬方式調用時不會真的調用後端接口，直接返回模擬結果。

5. 限製訪問

發布API時可以指定這個API能接受的訪問頻度限製，即每秒最多調用次數。還可以指定這個API是否不需要授權就可以訪問，以及誰可以看到並訂購消費該API，即所謂的API可見域（可見域的功能暫未生效）。

6. 發布服務

最後一步將之前輸入的服務信息綜合起來展示，確認無誤後即可執行發布。

最後更新：2016-11-23 17:41:41

  上一篇： 用戶實例與授權示例__用戶手冊_雲服務總線 CSB-阿裏雲

  下一篇： 發布管理__使用說明_用戶手冊_雲服務總線 CSB-阿裏雲