插件
API7 企业版插件扩展 API7 企业版的功能,满足组织或用户在流量管理、可观测性、安全、请求/响应转换、无服务器计算等方面的特定需求。
API7 企业版提供了许多插件,可以根据你的需求进行定制和编排。插件可以全局启用,作用于每个传入请求,也可以局部绑定到路由、服务或消费者等其他对象。
如果现有 API7 企业版插件无法满足需求,你也可以使用 Lua,或 Java、Python、Go、Wasm 等其他语言编写自己的插件。
插件执行生命周期
插件配置会根据定义的 JSON Schema进行检查,确保插件配置模式正确。
当请求经过 API7 企业版时,插件的相应方法会在以下一个或多个阶段执行:rewrite、access、before_proxy、header_filter、body_filter 和 log。这些阶段很大程度上受到 OpenResty 指令的影响。

有关自定义插件开发中各阶段的更多信息,请参阅插件开发操作指南。
插件执行顺序
通常,插件按以下顺序执行:
-
全局规则中的插件
- rewrite 阶段的插件
- access 阶段的插件
-
绑定到其他对象的插件
- rewrite 阶段的插件
- access 阶段的插件

在每个阶段中,你可以在插件的 _meta.priority 属性中定义新的优先级值。执行时,该值优先于插件的默认优先级。优先级值较高的插件先执行。
插件合并优先级
当同一个插件既在全局规则中全局配置,又在路由等对象中局部配置时,两个插件实例会依次执行。

但是,如果在多个对象中局部配置同一个插件,则只使用一份配置。执行时,这些对象中的插件按特定优先级顺序合并:
Consumer > Route > Service
因此,如果同一个插件在不同对象中具有不同配置,则使用优先级最高的插件配置。
插件执行过滤器
默认情况下,所有插件都会由匹配路由配置规则的传入请求触发。有时,你可能希望更精细地控制插件的执行。
API7 企业版允许通过插件的 _meta.filter 配置动态控制插件执行。该配置支持求值多种内置变量和 API7 企业版表达式。
插件全局规则
插件全局规则对象用于创建由每个传入请求触发的插件。全局规则会先于局部绑定到对象的其他插件执行。限流和可观测性等插件经常全局启用,为 API 提供一致、全面的保护。
下图展示如何为传入请求全局启用 prometheus 插件,并在路由上启用 proxy-rewrite 插件来修改请求的 HTTP 请求头。

本示例分别在全局规则和路由上启用了两个不同的插件。如果在两个对象上配置同一个插件,该插件会依次执行。
插件元数据
插件元数据用于配置所有同名插件实例的公共元数据字段。当同一个插件在多个对象中启用,且需要统一更新其元数据字段时,插件元数据很有用。
下图说明插件元数据的概念: namespace: api7

默认情况下,插件元数据对象中的 log_format 应将相同的日志格式统一应用于两个 syslog 插件。但是,/order 路由上的 syslog 插件具有不同的 log_format,因此该路由的请求会按路由上插件指定的 log_format 生成日志。
如果某个插件字段同时在插件元数据和其他对象中定义,则优先使用该对象中的定义。
插件元数据对象只能用于具有元数据字段的插件。关于哪些插件具有元数据字段,请参阅插件文档。