Skip to main content
Version: Next




echo is a useful plugin to help users understand as fully as possible how to develop an APISIX plugin.

This plugin addresses the corresponding functionality in the common phases such as init, rewrite, access, balancer, header filter, body filter and log.

NOTE: echo plugin is written as an example. There are some unhandled cases and you should not use it in the production!


before_bodystringoptionalBody before the filter phase.
bodystringoptionalBody to replace upstream response.
after_bodystringoptionalBody after the modification of filter phase.
headersobjectoptionalNew headers for response

At least one of before_body, body, and after_body must be specified.

How To Enable#

The following is an example on how to enable the echo plugin for a specific route.

curl -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "plugins": {        "echo": {            "before_body": "before the body modification "        }    },    "upstream": {        "nodes": {            "": 1        },        "type": "roundrobin"    },    "uri": "/hello"}'

Test Plugin#

  • success:
$ curl -i 200 OK...before the body modification hello world

Disable Plugin#

Remove the corresponding json configuration in the plugin configuration to disable the echo. APISIX plugins are hot-reloaded, therefore no need to restart APISIX.

$ curl  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "methods": ["GET"],    "uri": "/hello",    "plugins": {},    "upstream": {        "type": "roundrobin",        "nodes": {            "": 1        }    }}'