This plugin transforms the routing on the fly in Kong, changing the upstream server, port, or path to hit. The substitutions can be configured via flexible templates.
Terminology
plugin: a plugin executing actions inside Kong before or after a request has been proxied to the upstream API.Service: the Kong entity representing an external upstream API or microservice.Route: the Kong entity representing a way to map downstream requests to upstream services.Consumer: an entity that makes requests for Kong to proxy; it represents either a user or an external service.Credential: a unique string associated with a Consumer, also referred to as an API key.upstream service: this refers to your own API/service sitting behind Kong, to which client requests are forwarded.
Configuration
Enabling the plugin on a Service
Configure this plugin on a Service by making the following request:
$ curl -X POST http://kong:8001/services/{service}/plugins \
--data "name=route-transformer-advanced"
{service} is the id or name of the Service that this plugin configuration will target.
Enabling the plugin on a Route
Configure this plugin on a Route with:
$ curl -X POST http://kong:8001/routes/{route}/plugins \
--data "name=route-transformer-advanced"
{route} is the id or name of the Route that this plugin configuration will target.
Enabling the plugin on a Consumer
You can use the http://localhost:8001/plugins endpoint to enable this plugin
on specific Consumers:
$ curl -X POST http://kong:8001/consumers/{consumer}/plugins \
--data "name=route-transformer-advanced" \
{consumer} is the id or username of the Consumer that this plugin configuration will target.
You can combine consumer.id and service.id in the same request, to furthermore narrow the scope of the plugin.
Global plugins
- Using a database, all plugins can be configured using the
http://kong:8001/plugins/endpoint. - Without a database, all plugins can be configured via the
plugins:entry on the declarative configuration file.
A plugin which is not associated to any Service, Route or Consumer (or API, if you are using an older version of Kong) is considered "global", and will be run on every request. Read the Plugin Reference and the Plugin Precedence sections for more information.
Parameters
Here's a list of all the parameters which can be used in this plugin's configuration:
| form parameter | description |
|---|---|
name | The name of the plugin to use, in this case route-transformer-advanced |
service.id | The ID of the Service the plugin targets. |
route.id | The ID of the Route the plugin targets. |
consumer.id | The ID of the Consumer the plugin targets. |
enableddefault value: true | Whether this plugin will be applied. |
config.path
optional |
Updates the upstream request path with given value/template. This value can only be used to update the path part of the URI, not the scheme, nor the hostname. |
config.host
optional |
Updates the upstream request Host with given value/template. This value can only be used to update the routing, it will not update the Host-header value. |
config.port
optional |
Updates the upstream request Port with given value/template. Note that the port as set may be overridden again by DNS resolution (in case of SRV records,or an Upstream) |
NOTE: the ‘advanced’ label is only attached since this is an enterprise only plugin. There is not a ‘regular’ version available.
Synopsis
This plugin transforms the routing on the fly in Kong, changing the upstream server/port/path to hit. The substitutions can be configured via flexible templates.
History
See the changelog.
Template as Value
The templates that can be used as values are the same as the request-transformer.