mirror of
https://gitee.com/iresty/apisix.git
synced 2024-12-15 09:21:26 +08:00
3.5 KiB
3.5 KiB
Summary
Name
response rewrite plugin, rewrite the content from upstream.
senario:
- can set
Access-Control-Allow-*
series field to support CORS(Cross-origin Resource Sharing). - we can set customized
status_code
andLocation
field in header to achieve redirect, you can alse use redirect plugin if you just want a redirection.
Attributes
Name | Requirement | Description |
---|---|---|
status_code | optional | New status code to client |
body | optional | New body to client, and the content-length will be reset too. |
headers | optional | Set the new headers for client, can set up multiple. If it exists already from upstream, 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 response rewrite
plugin on the specified route:
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"methods": ["GET"],
"uri": "/test/index.html",
"plugins": {
"response-rewrite": {
"body": "{\"code\":\"ok\",\"message\":\"new json body\"}",
"headers": {
"X-Server-id": 3,
"X-Server-status": "on"
}
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:80": 1
}
}
}'
Test Plugin
Testing based on the above examples :
curl -X GET -i http://127.0.0.1:9080/test/index.html
It will output like below,no matter what kind of content from upstream.
HTTP/1.1 200 OK
Date: Sat, 16 Nov 2019 09:15:12 GMT
Transfer-Encoding: chunked
Connection: keep-alive
X-Server-id: 3
X-Server-status: on
{"code":"ok","message":"new json body"}
This means that the response rewrite
plugin is in effect.
Disable Plugin
When you want to disable the response 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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"methods": ["GET"],
"uri": "/test/index.html",
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:80": 1
}
}
}'
The response rewrite
plugin has been disabled now. It works for other plugins.