文档

概述

更新时间:

1. 插件使用规则

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

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

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

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

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

  • API的下线操作会解除插件的绑定关系,再次发布后需要重新绑定插件。

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

2. 支持插件列表

目前API网关支持下列插件,请单击链接查看:

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` 调试。

  • 本页导读 (0)