echo - Apisix — ContextQMD

Description

The echo Plugin is to help users understand how they can develop an APISIX Plugin.

This Plugin addresses common functionalities in phases like init, rewrite, access, balancer, header filter, body filter and log.

:::caution WARNING

The echo Plugin is built as an example. It has missing cases and should not be used in production environments.

:::

Attributes

Name	Type	Requirement	Description
before_body	string	optional	Body to use before the filter phase.
body	string	optional	Body that replaces the Upstream response.
after_body	string	optional	Body to use after the modification phase.
headers	object	optional	New headers to use for the response.

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

Enable Plugin

The example below shows how you can enable the echo Plugin for a specific Route:

:::note You can fetch the admin_key from config.yaml and save to an environment variable with the following command:

bash

admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')

:::

shell

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

Example usage

First, we configure the Plugin as mentioned above. We can then make a request as shown below:

shell

curl -i http://127.0.0.1:9080/hello

HTTP/1.1 200 OK
...
before the body modification hello world

Delete Plugin

To remove the echo Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.

shell

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