API路由是訪問上游目標的路徑,在API安全網關中,路由首先通過預定的規則來匹配客戶端請求,然后加載和執行相應的插件,最后將請求轉發至特定的服務。
創建API
1.登錄API安全網關。
2.在左側導航欄選擇“資源 > API”,進入API列表頁面。
3.單擊頁面左上角的“新增”按鈕,開始新增API。
| 字段 | 說明 |
|---|---|
| API基本信息 | |
| 關聯服務 | 為該API選擇一個關聯的服務,該API會新增在對應服務目錄下。 說明 API需要關聯到具體的服務,如何創建服務請參考:服務章節。 |
| API名稱 | 填寫API路由名稱,不允許重復。 |
| 描述 | 填寫API路由的描述。 |
| 發布 | 發布的API允許訪問。 |
| 協議 |
|
| API版本 | 填寫API路由版本,管理不同版本的API,使得新舊版本可以并行存在且互不影響,方便客戶端平滑升級。 |
| 匹配條件 | |
| 路徑 | HTTP請求路徑,如/foo/index.html;支持請求路徑前綴/foo/*、/* 代表所有路徑,支持添加多條 |
| HTTP方法 | 匹配指定的HTTP方法 |
| 優先級 | 默認0,數字越大,優先級越高 |
| 高級匹配條件 | |
| 高級匹配條件 | 參數位置:支持選擇HTTP請求頭、請求參數、POST請求參數、Cookie、內置參數。 參數名稱:自定義參數名稱。 非(!):開啟是否取反。 運算符:選擇運算符。 參數值:填寫參數值,具體請根據您選擇的參數位置決定。 |
4.配置完成后,單擊“下一步”,進入“配置請求處理”。
| 字段 | 說明 |
|---|---|
| 請求改寫 | |
| 路徑改寫 |
|
| 域名改寫 |
|
| HTTP方法改寫 |
|
| 請求頭添加 | 輸入請求頭的參數名和參數值,添加指定請求頭。 |
| 請求頭改寫 | 輸入請求頭的參數名和參數值,將指定請求頭的值改寫。 |
| 請求頭移除 | 輸入請求頭參數,刪除指定參數。 |
5.配置完后單擊“下一步”進入配置返回處理步驟。
| 字段 | 說明 |
|---|---|
| 配置返回處理 | |
| API調用者 |
|
| 新增脫敏策略 | 根據配置的標簽和算法進行脫敏。 |
6.添加完成后,單擊“下一步”,進入插件配置環節,具體的插件功能請參照控制臺說明,若需要啟用插件單擊對應插件下方的“啟用”按鈕即可啟用。
7.完成插件配置后,單擊“下一步”確認API信息,若信息無誤單擊“保存”即可完成添加API。
導入/導出API
1.登錄API安全網關。
2.在左側導航欄選擇“資源 > API”,進入API列表頁面。
3.單擊頁面上方的“導入/導出API”按鈕。
4.在彈出的對話框中選擇YAML或JSON文件導入即可。
說明
目前僅支持YAML、JSON兩種文本格式的描述文件。
導入已存在的API會默認跳過,最多可創建50個API。
上傳的文件將覆蓋編輯器中的內容,文件大小不可以超過100KB。
后續操作
生命周期管理:選擇需要上線/下線的API,單擊“操作”列的“上線/下線”按鈕即可上線/下線API。
配置API:選擇需要配置的API,單擊“操作”列的“配置”按鈕即可配置API。
刪除API:選擇需要刪除的API,單擊“操作”列的“刪除”按鈕即可刪除API。
查看API:選擇需要查看的API,單擊“操作”列的“更多 > 查看”按鈕即可查看API。
克隆API:選擇需要克隆的API,選擇“操作”列的“更多 > 克隆”按鈕即可克隆API。