創建API前,需要先創建API分組。API分組相當于API的集合,API提供者以API分組為單位,管理分組內的所有API。
目前支持以下創建分組方式:
說明
? 對外開放API時,您需要為API分組綁定自己的獨立域名。
??一個API只能屬于某一個API分組。
??API分組創建后,系統為分組自動分配一個內部測試用的調試域名,此調試域名每天最多可以訪問1000次。
??實例創建后,有一個DEFAULT分組,可直接通過虛擬私有云地址調用默認分組中的API。
前提條件
已創建API網關實例。
直接創建
步驟 1 進入API網關控制臺頁面。
步驟 2 根據實際業務在左側導航欄上方選擇實例。
步驟 3 在左側導航欄選擇“API管理 > API分組”。
步驟 4 單擊“創建API分組 > 直接創建”,在彈框中填寫分組信息。
參數
說明
分組名稱
API分組名稱,用于將API接口進行分組管理。
描述
對分組的介紹。
步驟 5 單擊“確定”,創建完成。
導入API設計文件
步驟 1 進入API網關控制臺頁面。
步驟 2 根據實際業務在左側導航欄上方選擇實例。
步驟 3 在左側導航欄選擇“API管理 > API分組”。
步驟 4 單擊“創建API分組 > 導入API設計文件”。
步驟 5 在彈窗中選擇本地路徑下的API文件,然后單擊“打開”導入文件。
步驟 6 填寫導入信息。
參數名稱
說明
導入方式
導入方式包含以下2種:
生成新的分組:將API定義導入到一個新的分組,導入過程中系統會自動創建一個新的API分組,并將導入的API歸屬到該分組。
選擇已有分組:將API定義導入到一個已有的分組,導入過程中不會刪除分組中已有的API,只是將新增的API導入分組。
API分組
僅在選擇“選擇已有分組”時,需要選擇API分組。
是否覆蓋
勾選后,當導入的API名稱與已有的API名稱相同時,導入的API會覆蓋已有的API。
僅在選擇“選擇已有分組”時,需要選擇是否覆蓋。
擴展覆蓋
勾選后,當導入API擴展定義項名稱(ACL,流控等)與已有的策略(ACL,流控等)名稱相同時,會覆蓋已有的策略(ACL,流控等)。
步驟 7 (可選)單擊“全局配置(可選)”。
-
選擇安全配置。
-
選擇后端請求配置。
-
單擊“下一步”,支持通過“表單”、“JSON”、“YAML”樣式查看配置詳情。
-
確認無誤后,單擊“提交”,完成配置。
步驟 8 單擊“立即導入”,在彈窗中選擇是否現在發布API到環境。
步驟 9 單擊“確定”,跳轉到“API運行”頁面,可查看分組下的API。