ext-plugin-pre-req

描述

ext-plugin-pre-req 插件用于在执行内置 Lua 插件之前和在 Plugin Runner 内运行特定的 External Plugin。

如果你想了解更多关于 External Plugin 的信息，请参考 External Plugin 。

ext-plugin-pre-req - 图1note

External Plugin 执行的结果会影响当前请求的行为。

属性

名称类型必选项默认值有效值描述
confarray否[{“name”: “ext-plugin-A”, “value”: “{\”enable\”:\”feature\”}”}]在 Plugin Runner 内执行的插件列表的配置。
allow_degradationboolean否false[false, true]当 Plugin Runner 临时不可用时是否允许请求继续，当值设置为 true 时则自动允许请求继续。

启用插件

以下示例展示了如何在指定路由中启用 ext-plugin-pre-req 插件：

ext-plugin-pre-req - 图2note

您可以这样从 config.yaml 中获取 admin_key 并存入环境变量：

  1. admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
  1. curl -i http://127.0.0.1:9180/apisix/admin/routes/1  \
  2. -H "X-API-KEY: $admin_key" -X PUT -d '
  3. {
  4.     "uri": "/index.html",
  5.     "plugins": {
  6.         "ext-plugin-pre-req": {
  7.             "conf" : [
  8.                 {"name": "ext-plugin-A", "value": "{\"enable\":\"feature\"}"}
  9.             ]
  10.         }
  11.     },
  12.     "upstream": {
  13.         "type": "roundrobin",
  14.         "nodes": {
  15.             "127.0.0.1:1980": 1
  16.         }
  17.     }
  18. }'

测试插件

通过上述命令启用插件后，可以使用如下命令测试插件是否启用成功：

  1. curl -i http://127.0.0.1:9080/index.html

在返回结果中可以看到刚刚配置的 Plugin Runner 已经被触发，同时 ext-plugin-A 插件也已经被执行。

删除插件

当你需要禁用 ext-plugin-pre-req 插件时，可通过以下命令删除相应的 JSON 配置，APISIX 将会自动重新加载相关配置，无需重启服务：

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1  \
  2. -H "X-API-KEY: $admin_key" -X PUT -d '
  3. {
  4.     "uri": "/index.html",
  5.     "upstream": {
  6.         "type": "roundrobin",
  7.         "nodes": {
  8.             "127.0.0.1:1980": 1
  9.         }
  10.     }
  11. }'