全部產品
Search
文件中心

API Gateway:概述

更新時間:Jul 13, 2024

1. 外掛程式使用規則

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

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

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

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

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

  • API的下線操作會解除外掛程式的綁定關係,再次發布後需要重新綁定外掛程式。

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

2. 支援外掛程式列表

目前API Gateway支援下列外掛程式,請單擊連結查看:

3. 快速使用

image

  • 單擊建立外掛程式按鈕建立外掛程式。image.png

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

image.png

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

4. 開發人員指南(OpenAPI)

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

  • 建立外掛程式:CreatePlugin

  • 修改外掛程式:ModifyPlugin

  • 刪除外掛程式:DeletePlugin

  • 查詢外掛程式:DescribePlugins

  • 綁定API外掛程式:AttachPlugin

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

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

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

5. 使用限制

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

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

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