文档

为分组绑定插件

更新时间:

本文主要介绍如何为API分组绑定插件,并验证插件是否对分组下的API生效。

1. 概述

插件是API网关提供的一种独立的配置组件,主要用于拓展API的功能,为API提供更多的定制能力和扩展选项,以满足用户的多样化需求。插件需绑定到API上才能生效,如果API的数量较多,那么绑定插件可能会变得繁琐且耗时,因此我们提供了分组绑定插件的能力。绑定到分组上的插件可以对分组下的所有API均生效,如果API也绑定了相同类型的插件,那么API绑定的插件具有更高的优先级。

2. 使用规则

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

  • 插件绑定到分组的指定环境后,插件策略会自动对该环境下已发布的API起作用。

  • 如果API和分组绑定了相同类型的插件,那么API绑定的插件具有更高的优先级。

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

  • 如果插件已绑定到某个分组,那么该插件无法执行删除操作。

3. 快速使用

  1. 登录API网关控制台,左侧栏找到开放API——插件管理

  2. 单击右上角创建插件,在页面中自定义插件名称,选择插件类型,配置插件规则。

  3. 配置好插件规则后,点击创建,随后在插件列表中就可以看到刚刚创建的插件了。

  4. 点击右侧的绑定分组按钮,选择需要绑定的分组及环境。

  5. 插件绑定完成后,选择该分组下的一个已发布的API进行调试,测试插件是否生效。

  6. 调试分组下的其他API,测试插件是否生效。

重要

如果API和分组绑定了相同类型的插件,那么API绑定的插件将覆盖分组绑定的插件,即API绑定的插件生效。

4. 使用限制

  • 单个插件元数据的大小限制为50KB

  • 每个用户在每个Region创建插件的限制为1000个。

  • 控制台的调试功能暂时不支持JWT插件,建议使用Postman或者系统curl命令调试。