操作場景

導出JSON或YAML格式的API。API網關支持單個API導出和批量API導出。

前提條件

已創建API分組和API。

操作步驟

步驟 1 進入API網關控制臺頁面。

步驟 2 根據實際業務在左側導航欄上方選擇實例。

步驟 3 在左側導航欄選擇“API管理 > API列表”。

步驟 4 單擊導出API。

步驟 5 設置如表 所示參數。

表 導出API

信息項
描述
API分組
選擇待導出API所在的API分組。
運行環境
選擇待導出API所在的環境。
API
默認導出API分組所在環境的所有的API，如果需要導出個別API，單擊“自定義導出API”，勾選需要導出的API名稱。
API定義范圍
l? ? 基礎定義：包括API前端請求定義和響應定義，不包括后端服務定義。其中API前端請求定義除了Swagger規范定義項外，還包括API網關的一些Swagger擴展字段。適用于生成Swagger或OpenAPI格式的API文檔定義。
l? ? 全量定義：包括API前端請求定義、后端服務定義和響應定義。適用于將API定義備份為Swagger或OpenAPI文件。
l? ? 擴展定義：包括API前端請求定義、后端服務定義和響應定義，還包括API關聯的流量控制、訪問控制等策略對象的定義。
導出格式
選擇JSON、YAML或YML。
自定義版本
為導出的API自定義版本號，如果沒有指定版本號，默認使用當前時間。
OpenAPI版本
選擇導出Swagger ? 2.0或OpenAPI 3.0定義的API。

步驟 6 單擊“導出”，右側顯示導出結果。