This is a Kong middleware to transform requests / responses, using pre-configured templates.

When using Kong, you can create routes that proxy to an upstream. The problem lies when the upstream has an ugly response/request contract. Sometimes the kong bundled request transformer is not enough. This plugin was created for those situations, it can apply a template to JSON requests and responses, transforming them pretty much however you like.

The plugin folder should contain at least a schema.lua and a handler.lua, alongside with a spec folder and a .rockspec file specifying the current version of the package.

We use lua-resty-template to write templates. It's also very important that you don't leave any \t in the files. We also only support JSON requests and responses for now.

Inside kong-plugin-template-transformer/template-transformer/validator/json/examples you'll find some examples for json templates and request files.

The .rockspec file should follow LuaRocks' conventions

Configure this plugin on a Route with:

curl -X POST http://kong:8001/routes/{route_id}/plugins \
    --data "name=kong-plugin-template-transformer"  \
    --data "config.request_template=http://new-url.com"
    --data "config.response_template=http://new-url.com"
    --data "config.hidden_fields=http://new-url.com"

• route_id: the id of the Route that this plugin configuration will target.
• config.request_template: Optional, the template to be applied before proxying to the upstream.
• config.response_template: Optional, the template to be applied before returning to the client.
• config.hidden_fields: Optional, a list of request or response fields that you do not want Kong to save them in a log file.

docker build . -t kong-plugin-template-transformer-dev
docker run -it -v ${PWD}/template-transformer:/template-transformer kong-plugin-template-transformer-dev bash

made with ❤️ by Stone Payments