Skip to main content
Version: 3.0.0-beta

echo

描述#

echo 插件可以帮助用户尽可能地全面了解如何开发 APISIX 插件。

该插件展示了如何在常见的 phase 中实现相应的功能,常见的 phase 包括:init, rewrite, access, balancer, header filter, body filter 以及 log。

WARNING

echo 插件只能用作示例,并不能处理一些特别的场景。请勿将该插件用在生产环境中!

属性#

名称类型必选项描述
before_bodystringbody 属性之前添加的内容,如果 body 属性没有指定,就会将其添加在上游 response body 之前。
bodystring返回给客户端的响应内容,它将覆盖上游返回的响应 body
after_bodystringbody 属性之后添加的内容,如果 body 属性没有指定将在上游响应 body 之后添加。
headersobject返回值的 headers。
note

参数 before_bodybodyafter_body 至少要配置一个。

启用插件#

以下示例展示了如何在指定路由中启用 echo 插件。

curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"plugins": {
"echo": {
"before_body": "before the body modification "
}
},
"upstream": {
"nodes": {
"127.0.0.1:1980": 1
},
"type": "roundrobin"
},
"uri": "/hello"
}'

测试插件#

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

curl -i http://127.0.0.1:9080/hello
HTTP/1.1 200 OK
...
before the body modification hello world

禁用插件#

当你需要禁用 echo 插件时,可通过以下命令删除相应的 JSON 配置,APISIX 将会自动重新加载相关配置,无需重启服务:

curl http://127.0.0.1:9180/apisix/admin/routes/1  \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"methods": ["GET"],
"uri": "/hello",
"plugins": {},
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:1980": 1
}
}
}'