概述
云原生網關的API管理集中控制API的路由、流量和安全。用戶可以配置API路由規則、請求處理、認證授權等功能,確保高效、安全的訪問。
操作步驟
- 登錄微服務引擎MSE云原生網關管理控制臺,選擇資源池。
- 在左側導航欄,選擇云原生網關 > 網關列表,進入對應網關實例的控制臺。
- 在左側導航欄,選擇API托管 > API列表。
創建API
API的創建過程分為四個步驟:
1、基本信息
分組:API所屬的分組,創建后不可修改。
API名稱:可填寫API的業務含義。
安全認證:選擇API的安全認證方式,開啟應用授權后,只有授權的應用才能訪問該API。
防重放攻擊:開啟后,請求頭必須包含x-ca-timestamp和x-ca-nonce參數。
2、定義API請求
請求路徑(Path):API的訪問路徑。如果分組設置了BasePath,API的最終訪問路徑將為BasePath+Path。創建后不可修改。
請求方法(HTTP Method):指定API的請求方式。創建后不可修改。
入參請求模式:支持三種模式,入參映射(過濾未知參數)、入參映射(透傳未知參數)、入參透傳。
入參定義:支持在query、header、path中定義參數。如果在path中定義了參數,必須確保該參數包含在Path中。
3、定義后端服務
后端服務:負責處理請求的后端服務。
后端請求路徑(Path):網關轉發請求到后端服務的路徑。如果在Path中定義了參數,后端請求路徑中必須包含相應參數。
請求方法(HTTP Method):指定請求后端服務的方式。
后端超時:設置請求后端服務的超時時間。
后端服務參數配置:將請求的入參與后端服務的入參一一對應,支持修改請求參數名。
常量參數:可以添加常量參數,并透傳到后端服務。
系統參數配置:支持添加系統參數,并透傳到后端服務。
4、定義返回結果
這里設置的API返回結果,僅用于生產文檔,不會對API的請求、響應產生影響。
API發布
創建或修改API后,不會立即生效,需進行發布操作。API支持多環境管理,發布時需選擇要發布的目標環境。
API下線
已發布的API,支持下線操作。點擊對應API右側省略號的下線按鈕可進入。
API克隆
API支持復制,會基于當前API,創建一個新的API。
API刪除
API支持單個、批量刪除操作。已發布的API,需要先下線后,才能進行刪除。