ext-plugin-pre-req

目录

简介

ext-plugin-pre-req 在执行大多数内置 Lua 插件执行之前，在 Plugin Runner 内运行特定 External Plugin。

为了理解什么是 Plugin Runner，请参考 external plugin 部分。

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

属性

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

如何启用

以下是一个示例，在指定路由中启用插件：

  1. curl -i http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/index.html",
  4.     "plugins": {
  5.         "ext-plugin-pre-req": {
  6.             "conf" : [
  7.                 {"name": "ext-plugin-A", "value": "{\"enable\":\"feature\"}"}
  8.             ]
  9.     },
  10.     "upstream": {
  11.         "type": "roundrobin",
  12.         "nodes": {
  13.             "127.0.0.1:1980": 1
  14.         }
  15.     }
  16. }'

测试插件

使用 curl 去测试：

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

你会看到配置的 Plugin Runner 将会被触发，同时 ext-plugin-A 插件将会被执行。

禁用插件

当你想去掉 ext-plugin-pre-req 插件的时候，很简单，在插件的配置中把对应的 json 配置删除即可，无须重启服务，即刻生效：

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

现在就已经移除 ext-plugin-pre-req 插件了。其他插件的开启和移除也是同样的方法。