Summary

Name
Attributes
How To Enable
Test Plugin
Disable Plugin

Name

upstream proxy info rewrite plugin.

Attributes

Name	Requirement	Description
scheme	optional	Upstream new `schema` forwarding protocol,options can be `http` or `https`,default `http`.
uri	optional	Upstream new `uri` forwarding address.
regex_uri	optional	Upstream new `uri` forwarding address. Use regular expression to match uri from client, when the match is successful, the uri template will be forwarded upstream. If the match is not successful, the uri from the client will be forwarded to the upstream. When `uri` and `regex_uri` are both exist, `uri` is used first. For example: [" ^/iresty/(.)/(.)/(.*)", "/$1-$2-$3"], the first element represents the matching regular expression and the second element represents the uri template that is forwarded to the upstream.
host	optional	Upstream new `host` forwarding address, example `iresty.com`.
enable_websocket	optional	enable `websocket`(boolean), default `false`.
headers	optional	Forward to the new `headers` of the upstream, can set up multiple. If it exists, will rewrite the header, otherwise will add the header. You can set the corresponding value to an empty string to remove a header.

How To Enable

Here's an example, enable the proxy rewrite plugin on the specified route:

curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d '
{
    "methods": ["GET"],
    "uri": "/test/index.html",
    "plugins": {
        "proxy-rewrite": {
            "uri": "/test/home.html",
            "scheme": "http",
            "host": "iresty.com",
            "enable_websocket": true,
            "headers": {
                "X-Api-Version": "v1",
                "X-Api-Engine": "apisix",
                "X-Api-useless": ""
            }
        }
    },
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:80": 1
        }
    }
}'

Test Plugin

Testing based on the above examples :

curl -X GET http://127.0.0.1:9080/test/index.html

Send the request and see upstream `access.log', if the output information is consistent with the configuration :

127.0.0.1 - [26/Sep/2019:10:52:20 +0800] iresty.com GET /test/home.html HTTP/1.1 200 38 - curl/7.29.0 - 0.000 199 107

This means that the proxy rewrite plugin is in effect.

Disable Plugin

When you want to disable the proxy rewrite plugin, it is very simple, you can delete the corresponding json configuration in the plugin configuration, no need to restart the service, it will take effect immediately :

curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d '
{
    "methods": ["GET"],
    "uri": "/test/index.html",
    "plugins": {},
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:80": 1
        }
    }
}'

The proxy rewrite plugin has been disabled now. It works for other plugins.

3.9 KiB Raw Blame History