响应重写

插件信息

名称	字段	属性
响应重写	response_rewrite	参数处理

功能描述

该插件用于重写网关返回的状态码、响应体、头部。当从上游返回的响应状态码满足对应状态码时，网关对响应内容进行重写。

注意事项：对状态码和响应体body是重写覆盖，但对头部信息是新增或修改。

Open Api

配置示例

示例说明：当响应状态码为200或者404时，响应状态码将被重写为201，响应头部设置demo_header: "1"，body被覆盖为{"重写响应体Body"}(以下配置的body已经过base64加密)。

{
	"status_code": 201,
	"body": "eyLph43lhpnlk43lupTkvZNCb2R5In0=",
	"body_base64": true,
	"headers": {
		"demo_header": "1"
	},
	"match": {
		"code": [404,200]
	}
}

配置参数说明

参数名	值类型	是否必填	默认值	值可能性	说明
status_code	int	是		200	新响应状态码, 闭区间范围为[200,598]
body	string	否			新响应体
body_base64	bool	否	false	false	新响应体的配置内容是否已经过base64加密
headers	map[string]string	否		{"name":"apinto"}	新增的响应头部信息
match	object	是			匹配条件
match->code	array_int	是		[200,201,202,203]	匹配状态码

注意事项：

• match->code参数是int数组，同时每个值得范围是[200,598]。

Open API 请求示例

全局配置

curl -X POST  'http://127.0.0.1:9400/api/setting/plugin' \
-H 'Content-Type:application/json' \
-d '{
  "plugins": [{
    "id": "eolinker.com:apinto:response_rewrite",
    "name": "my_response_rewrite",
    "type": "service",
	"status": "enable"
  }]
}'

配置带有响应重写插件的服务

配置说明：当响应状态码为200或者404时，响应状态码将被重写为201，响应头部设置demo_header: "1"，body被覆盖为{"重写响应体Body"}(以下配置的body已经过base64加密)。

全局插件具体配置点此进行跳转。

curl -X POST 'http://127.0.0.1:9400/api/service' -H 'Content-Type:application/json' \
-d '{
 "name": "response_rewrite_service",
 "driver": "http",
 "timeout": 3000,
 "retry": 3,
 "scheme": "http",
 "nodes": ["demo.apinto.com:8280"],
 "balance": "round-robin",
 "plugins": {
  "my_response_rewrite": {
  "disable": false,
  "config": {
    "status_code": 201,
    "body": "eyLph43lhpnlk43lupTkvZNCb2R5In0=",
    "body_base64": true,
    "headers": {
     "demo_header": "1"
	},
	"match": {
	 "code": [ 404, 200 ]
	}
   }
  }
 }
}' 

绑定路由

curl -X POST  'http://127.0.0.1:9400/api/router' \
-H 'Content-Type:application/json' \
-d '{
    "name":"response_rewrite_router",
    "driver":"http",
    "listen":8099,
    "rules":[{
        "location":"/demo/response_rewrite"
    }],
    "target":"response_rewrite_service@service"
}'

接口请求示例

curl -i -X GET 'http://127.0.0.1:8099/demo/response_rewrite' -H 'Content-Type:application/json'

接口访问返回示例

HTTP/1.1 201 Created
Server: fasthttp
Date: Mon, 13 Dec 2021 03:36:50 GMT
Content-Type: text/plain; charset=utf-8
Content-Length: 23
Demo_header: 1

{"重写响应体Body"}