概述

1. 插件使用规则

• 一个API只能绑定一个相同类型的插件。

• 插件仅与Region相关，可以绑定至本Region的API，每个用户的插件限额为1000个。

• 插件策略和API分别是独立管理的，将插件绑定到API的指定环境后，插件策略才会对已绑定的API起作用。

• 必须要发布API后才可将插件绑定至API对应发布的环境。

• 插件的绑定、解绑、更新会实时生效，不需要重新发布API，对于风险比较高的API，请先在测试API上测试通过。

• API的下线操作不会解除与插件的绑定关系，重新发布后将自动绑定插件。

• 如果插件上有已发布或者发布过但未删除的API，则插件无法执行删除操作。

2. 支持插件列表

目前API网关支持下列插件，插件执行顺序为从上而下，具体插件配置请点击链接查看：

• CORS（跨域资源访问）

• Basic Auth插件

• JWT认证插件

• 第三方鉴权插件

• IP访问控制

• 流量控制

• 参数访问控制

• Caching（缓存）

• Routing（后端路由）

• 断路器

• 后端签名插件

• 请求应答改写插件（处理请求改写部分）

• 错误码映射

• 请求应答改写插件（处理应答改写部分）

• 日志脱敏插件

3. 快速使用

• 访问API网关插件控制台。

• 单击创建插件按钮创建插件。在创建插件页面，地域选择华东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` 调试。