概述

1. 外掛程式使用規則

• 一個API只能綁定一個相同類型的外掛程式。

• 外掛程式僅與Region相關，可以綁定至本Region的API，每個使用者的外掛程式限額為1000個。

• 外掛程式策略和API分別是獨立管理的，將外掛程式綁定到API的指定環境後，外掛程式策略才會對已綁定的API起作用。

• 必須要發布API後才可將外掛程式綁定至API對應發布的環境。

• 外掛程式的綁定、解除綁定、更新會即時生效，不需要重新發布API，對於風險比較高的API，請先在測試API上測試通過。

• API的下線操作不會解除與外掛程式的綁定關係，重新發布後將自動綁定外掛程式。

• 如果外掛程式上有發行或者發布過但未刪除的API，則外掛程式無法執行刪除操作。

2. 支援外掛程式列表

目前API Gateway支援下列外掛程式，外掛程式執行順序為從上而下，具體外掛程式配置請點選連結查看：

• CORS（跨域資源訪問）

• Basic Auth外掛程式

• JWT認證外掛程式

• 第三方鑒權外掛程式

• IP存取控制

• 流量控制

• 參數存取控制

• Caching（緩衝）

• Routing（後端路由）

• 斷路器

• 後端簽名外掛程式

• 請求應答改寫外掛程式（處理請求改寫部分）

• 錯誤碼映射

• 請求應答改寫外掛程式（處理應答改寫部分）

• 日誌脫敏外掛程式

3. 快速使用

• 訪問API Gateway外掛程式控制台。

• 單擊建立外掛程式按鈕建立外掛程式。在建立外掛程式頁面，地區選擇華東1（杭州），填寫外掛程式名稱（如 test），在外掛程式類型下拉式清單中選擇所需類型，可選項包括：流量控制、IP存取控制、後端簽名、JWT鑒權、Basic Auth、跨域資源訪問、緩衝、後端路由、參數存取控制、錯誤碼映射、斷路器（僅專享執行個體）、第三方鑒權（僅專享執行個體）、日誌脫敏（僅專享執行個體）、請求應答改寫（僅專享執行個體）。選擇外掛程式類型後，頁面下方指令碼配置地區顯示對應的 YAML 配置模板（如流量控制的基礎配置案例，包含 unit、apiDefault、userDefault、appDefault、specials 等參數），可根據需要修改配置內容。

• 通過外掛程式控制台將外掛程式綁定至發行的API當中。

在綁定API彈窗中，選擇目標 API 分組和運行環境，單擊搜尋找到目標 API，單擊+ 添加將其加入已挑選清單，然後單擊確定完成綁定。如果該 API 已綁定同類型外掛程式，本次綁定將覆蓋原有外掛程式。

• 綁定後外掛程式即可生效。

4. 開發人員指南（OpenAPI）

外掛程式管理相關的OPENAPI如下：

• 建立外掛程式：CreatePlugin

• 修改外掛程式：ModifyPlugin

• 刪除外掛程式：DeletePlugin

• 查詢外掛程式：DescribePlugins

• 綁定API外掛程式：AttachPlugin

• 解除綁定API外掛程式：DetachPlugin

• 查詢外掛程式綁定的APIs：DescribePluginApis

• 查詢API綁定的外掛程式：DescirbePluginsByApi

5. 使用限制

• 單個外掛程式中繼資料的大小限制為50KB。

• 每個使用者在每個Region建立外掛程式的限制為1000個。

• 控制台的調試功能暫時不支援JWT外掛程式，建議使用Postman或者系統命令列 `curl` 調試。