echo

描述

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

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

echo - 图1WARNING

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

属性

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

参数 before_body、body 和 after_body 至少要配置一个。

启用插件

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

echo - 图3note

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

  1. admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
echo - 图4note

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

  1. admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
  2. -H "X-API-KEY: $admin_key" -X PUT -d '
  3. {
  4.     "plugins": {
  5.         "echo": {
  6.             "before_body": "before the body modification "
  7.         }
  8.     },
  9.     "upstream": {
  10.         "nodes": {
  11.             "127.0.0.1:1980": 1
  12.         },
  13.         "type": "roundrobin"
  14.     },
  15.     "uri": "/hello"
  16. }'

测试插件

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

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

删除插件

当你需要禁用 echo 插件时，可通过以下命令删除相应的 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.     "methods": ["GET"],
  5.     "uri": "/hello",
  6.     "plugins": {},
  7.     "upstream": {
  8.         "type": "roundrobin",
  9.         "nodes": {
  10.             "127.0.0.1:1980": 1
  11.         }
  12.     }
  13. }'