文档中心

主题

ext-plugin-pre-req ​

本文介绍了关于 APIX ext-plugin-pre-req 插件的基本信息及使用方法。

描述 ​

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

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

:::note

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

:::

属性 ​

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

启用插件 ​

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

shell
curl -i http://127.0.0.1:9180/apix/admin/routes/1  \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "uri": "/index.html",
    "plugins": {
        "ext-plugin-pre-req": {
            "conf" : [
                {"name": "ext-plugin-A", "value": "{\"enable\":\"feature\"}"}
            ]
        }
    },
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'

测试插件 ​

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

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

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

禁用插件 ​

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

shell
curl http://127.0.0.1:9180/apix/admin/routes/1  \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "uri": "/index.html",
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'