Response Transformer

You are browsing documentation for an outdated plugin version.

Looking for the plugin's configuration parameters? You can find them in the Response Transformer configuration reference doc.

Transform the response sent by the upstream server on the fly before returning the response to the client.

For additional response transformation features, check out the Response Transformer Advanced plugin.

The advanced plugin adds the following abilities:

• When transforming a JSON payload, transformations are applied to nested JSON objects and arrays. This can be turned off and on using the config.dots_in_keys configuration parameter. See Response Transformer Advanced arrays and nested objects.
• Transformations can be restricted to responses with specific status codes using various config.*.if_status configuration parameters.
• JSON body contents can be restricted to a set of allowed properties with config.allow.json.
• The entire response body can be replaced using config.replace.body.
• Arbitrary transformation functions written in Lua can be applied.
• The plugin will decompress and recompress Gzip-compressed payloads when the Content-Encoding header is gzip. Response Transformer Advanced includes the following additional configurations: add.if_status, append.if_status, remove.if_status, replace.body, replace.if_status, transform.functions, transform.if_status, allow.json, rename.if_status, transform.json, and dots_in_keys.

Notes:

• Transformations on the response body can cause changes in performance. To parse and modify a JSON body, the plugin needs to retain it in memory, which might cause pressure on the worker’s Lua VM when dealing with large bodies (several MB). Because of Nginx’s internals, the Content-Length header will not be set when transforming a response body.
• If the value contains a , then the comma separated format for lists cannot be used. Array notation must be used instead.

Order of execution

The plugin performs the response transformation in following order:

remove –> rename –> replace –> add –> append

Examples

In these examples we have the plugin enabled on a Route. This would work similar for Services.

• Add multiple headers by passing each header:value pair separately:

curl -X POST http://localhost:8001/routes/{route}/plugins \
  --data "name=response-transformer" \
  --data "config.add.headers[1]=h1:v2" \
  --data "config.add.headers[2]=h2:v1"

plugins:
- name: response-transformer
  route: {route}
  config:
    add:
      headers: ["h1:v2", "h2:v1"]

• Add multiple headers by passing comma separated header:value pair (only possible with a database):

curl -X POST http://localhost:8001/routes/{route}/plugins \
  --data "name=response-transformer" \
  --data "config.add.headers=h1:v2,h2:v1"

• Add multiple headers passing config as JSON body (only possible with a database):

curl -X POST http://localhost:8001/routes/{route}/plugins \
  --header 'content-type: application/json' \
  --data '{"name": "response-transformer", "config": {"add": {"headers": ["h1:v2", "h2:v1"]}}}'

• Add a body property and a header:

curl -X POST http://localhost:8001/routes/{route}/plugins \
  --data "name=response-transformer" \
  --data "config.add.json=p1:v1,p2:v2" \
  --data "config.add.headers=h1:v1"

plugins:
- name: response-transformer
  route: {route}
  config:
    add:
      json: ["p1:v1", "p2:v2"]
      headers: ["h1:v1"]

• Append multiple headers and remove a body property:

curl -X POST http://localhost:8001/routes/{route}/plugins \
  --header 'content-type: application/json' \
  --data '{"name": "response-transformer", "config": {"append": {"headers": ["h1:v2", "h2:v1"]}, "remove": {"json": ["p1"]}}}'

plugins:
- name: response-transformer
  route: {route}
  config:
    append:
      headers: ["h1:v2", "h2:v1"]
    remove:
      json: ["p1"]

• Explicitly set the type of the added JSON value -1 to be a number (instead of the implicitly inferred type string) if the response code is 500:

curl -X POST http://localhost:8001/routes/{route}/plugins \
  --data "name=response-transformer" \
  --data "config.add.json=p1:-1" \
  --data "config.add.json_types=number"