echo

目录

简介

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

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

注意：该插件仅用作示例，并没有处理一些特别的场景。请勿将之用于生产环境上！

属性

名称类型必选项默认值有效值描述
before_bodystring可选在 body 属性之前添加的内容，如果 body 属性没有指定将添加在 upstream response body 之前。
bodystring可选返回给客户端的响应内容，它将覆盖 upstream 返回的响应 body。
after_bodystring可选在 body 属性之后添加的内容，如果 body 属性没有指定将在 upstream 响应 body 之后添加。
headersobject可选返回值的 headers

参数 before_body，body 和 after_body 至少要存在一个

如何启用

为特定路由启用 echo 插件。

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "plugins": {
  4.         "echo": {
  5.             "before_body": "before the body modification "
  6.         }
  7.     },
  8.     "upstream": {
  9.         "nodes": {
  10.             "127.0.0.1:1980": 1
  11.         },
  12.         "type": "roundrobin"
  13.     },
  14.     "uri": "/hello"
  15. }'

测试插件

  • 成功:
  1. $ curl -i http://127.0.0.1:9080/hello
  2. HTTP/1.1 200 OK
  3. ...
  4. before the body modification hello world

禁用插件

当您要禁用 echo 插件时，这很简单，您可以在插件配置中删除相应的 json 配置，无需重新启动服务，它将立即生效：

  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "methods": ["GET"],
  4.     "uri": "/hello",
  5.     "plugins": {},
  6.     "upstream": {
  7.         "type": "roundrobin",
  8.         "nodes": {
  9.             "127.0.0.1:1980": 1
  10.         }
  11.     }
  12. }'