全部產品
Search
文件中心

API Gateway:為分組綁定外掛程式

更新時間:Jan 04, 2025

本文主要介紹如何為API分組綁定外掛程式,並驗證外掛程式是否對分組下的API生效。

1. 概述

外掛程式是API Gateway提供的一種獨立的配置組件,主要用於拓展API的功能,為API提供更多的定製能力和擴充選項,以滿足使用者的多樣化需求。外掛程式需綁定到API上才會生效,如果API的數量較多,那麼綁定外掛程式可能會變得繁瑣且耗時,因此我們提供了分組綁定外掛程式的能力。綁定到分組上的外掛程式可以對分組下的所有API均生效,如果API也綁定了相同類型的外掛程式,那麼API綁定的外掛程式具有更高的優先順序。

2. 使用規則

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

  • 外掛程式綁定到分組的指定環境後,外掛程式策略會自動對該環境下發行的API起作用。

  • 如果API和分組綁定了相同類型的外掛程式,那麼API綁定的外掛程式具有更高的優先順序。

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

  • 如果外掛程式已綁定到某個分組,那麼該外掛程式無法執行刪除操作。

3. 快速使用

  1. 登入API Gateway控制台,進入左側導覽列的API管理 > 外掛程式管理

  2. 單擊右上方建立外掛程式,在頁面中自訂外掛程式名稱,選擇外掛程式類型,配置外掛程式規則。

  3. 配置好外掛程式規則後,單擊建立,隨後在外掛程式列表中可以看到剛剛建立的外掛程式。

  4. 單擊目標外掛程式右側操作列的綁定分組按鈕,選擇需要綁定的分組及環境。

  5. 外掛程式綁定完成後,選擇該分組下的一個發行的API進行調試,測試外掛程式是否生效。

  6. 調試分組下的其他API,測試外掛程式是否生效。

重要

如果API和分組綁定了相同類型的外掛程式,那麼API綁定的外掛程式將覆蓋分組綁定的外掛程式,即API綁定的外掛程式生效。

4. 使用限制

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

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

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