转发重写V2
插件信息
名称 | 字段 | 属性 |
---|---|---|
转发重写V2 | proxy_rewrite_v2 | 参数处理 |
功能描述
该插件是转发重写插件v2版,用于对上游代理信息进行重写,支持对path
、host
的重写,同时支持对转发请求的请求头部header的键值进行新增,修改或者删除。
注意事项:
- 对转发路径path的重写支持静态重写,前缀替换,正则替换
配置参数说明
参数名 | 值类型 | 是否必填 | 值可能性 | 默认值 | 说明 |
---|---|---|---|---|---|
path_type | string | 否 | [“none”,“static”,“prefix”,“regex”] | "none" | 转发路径重写类型,static是静态替换,prefix是前缀替换,regex是正则替换 |
static_path | string | 否 | /test | 重写转发时的请求路径,path_type为static时需要填写 | |
prefix_path | array_object | 否 | 对转发请求的路径进行前缀替换,path_type为prefix时需要填写 | ||
prefix_path -> prefix_path_match | string | 否 | /prefix | path前缀匹配字符串,如:/prefix | |
prefix_path -> prefix_path_replace | string | 否 | /new-prefix | path前缀替换字符串,如:/new-prefix | |
regex_path | array_object | 否 | 对转发请求的路径进行正则替换,path_type为regex时需要填写 | ||
regex_path -> regex_path_match | string | 否 | /path/([a-z]+)/([a-z]+) | path正则匹配表达式,如: | |
regex_path -> regex_path_replace | string | 否 | /path/$2/$1 | path正则替换表达式,如:/path/$2/$1 ,对路径上第二个参数和第三个参数进行替换 | |
not_match_err | bool | 否 | false | false | path替换失败不进行转发,返回报错信息及状态码400 |
host_rewrite | bool | 否 | false | false | 是否重写host |
host | string | 否 | 127.0.0.1 | 设置转发请求的新host地址 | |
headers | map[string]string | 否 | {"name":"apinto"} | 能对转发请求的头部值进行新增,修改或删除 |
注意事项:
- prefix_path,regex_path两个配置字段为object数组,有顺序。若数组里配置多个object,替换顺序是从第一个依次到最后一个,仅会匹配替换一次。若not_match_err配置为true,当均替换失败时则会转发失败,返回报错信息以及400。若not_match_err配置为false,则会继续进行转发,转发路径不变。
- headers配置字段:能对转发请求的头部值进行新增,修改或删除
新增,修改:直接设置键值对即可。需要注意的是对以下特殊头部的修改只会在原有值的末尾添加上新值,除此之外的头部值会直接进行覆盖。
- Content-Type
- Content-Length
- Connection
- Cookie
- Transfer-Encoding
- Host
- User-Agent
删除:配置的键值对里的值为空字符串时,即为删除指定头部
全局开启转发重写V2插件
配置带有转发重写插件V2的服务
配置说明:将转发请求的路径path
设置为/apinto/demo
,host
设置为 127.0.0.1
,同时请求头部中新增apinto:demo
。