proxy-rewrite.md

title	keywords	description
proxy-rewrite	Apache APISIX API 网关 Plugin Proxy Rewrite proxy-rewrite	本文介绍了关于 Apache APISIX `proxy-rewrite` 插件的基本信息及使用方法。

描述

proxy-rewrite 是处理上游代理信息重写的插件，支持对 scheme、uri、host 等信息进行重写。

属性

名称	类型	必选项	默认值	有效值	描述
uri	string	否			转发到上游的新 uri 地址。支持 NGINX variables 变量，例如：$arg_name。
method	string	否		["GET", "POST", "PUT", "HEAD", "DELETE", "OPTIONS","MKCOL", "COPY", "MOVE", "PROPFIND", "PROPFIND","LOCK", "UNLOCK", "PATCH", "TRACE"]	将路由的请求方法代理为该请求方法。
regex_uri	array[string]	否			使用正则表达式匹配来自客户端的 uri，如果匹配成功，则使用模板替换转发到上游的 uri，如果没有匹配成功，则将客户端请求的 uri 转发至上游。当同时配置 uri 和 regex_uri 属性时，优先使用 uri。当前支持多组正则表达式进行模式匹配，插件将逐一尝试匹配直至成功或全部失败。例如：["^/iresty/(.*)/(.*)/(.*)", "/$1-$2-$3", ^/theothers/(.*)/(.*)", "/theothers/$1-$2"]，奇数索引的元素代表匹配来自客户端请求的 uri 正则表达式，偶数索引的元素代表匹配成功后转发到上游的 uri 模板。请注意该值的长度必须为偶数值。
host	string	否			转发到上游的新 host 地址，例如：iresty.com。
headers	object	否
headers.add	object	否			添加新的请求头，如果头已经存在，会追加到末尾。格式为 {"name": "value", ...}。这个值能够以 $var 的格式包含 NGINX 变量，比如 $remote_addr $balancer_ip。也支持以变量的形式引用 regex_uri 的匹配结果，比如 $1-$2-$3。
headers.set	object	否			改写请求头，如果请求头不存在，则会添加这个请求头。格式为 {"name": "value", ...}。这个值能够以 $var 的格式包含 NGINX 变量，比如 $remote_addr $balancer_ip。也支持以变量的形式引用 regex_uri 的匹配结果，比如 $1-$2-$3。请注意，若想设置 Host 请求头，应使用 host 属性。
headers.remove	array	否			移除请求头。格式为 ["name", ...]。
use_real_request_uri_unsafe	boolean	否	false		使用 real_request_uri（nginx 中的原始 $request_uri）绕过 URI 规范化。启用它被认为是不安全的，因为它会绕过所有 URI 规范化步骤。

Header 优先级

Header 头的相关配置，遵循如下优先级进行执行：

add > remove > set

启用插件

你可以通过如下命令在指定路由上启用 proxy-rewrite 插件：

:::note

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

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

:::

curl http://127.0.0.1:9180/apisix/admin/routes/1  \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
    "methods": ["GET"],
    "uri": "/test/index.html",
    "plugins": {
        "proxy-rewrite": {
            "uri": "/test/home.html",
            "host": "iresty.com",
            "headers": {
                "set": {
                    "X-Api-Version": "v1",
                    "X-Api-Engine": "apisix",
                    "X-Api-useless": ""
                },
                "add": {
                    "X-Request-ID": "112233"
                },
                "remove":[
                    "X-test"
                ]
            }
        }
    },
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:80": 1
        }
    }
}'

测试插件

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

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

发送请求，查看上游服务的 access.log，如果输出信息与配置一致则表示 proxy-rewrite 插件已经生效。示例如下：

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

删除插件

当你需要禁用 proxy-rewrite 插件时，可以通过以下命令删除相应的 JSON 配置，APISIX 将会自动重新加载相关配置，无需重启服务：

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