Community Plugin: This plugin is developed, tested, and maintained by a third-party contributor.
This plugin transform the response sent by the upstream server on the fly on Kong from json to xml,before returning the response to the client.Because of Nginx’s internals, the Content-Length
header will not be set when transforming a response body.
Installation
Recommended:
1
2
3
| $ git clone https://github.com/kakascx/apig-response-transform /opt/kong/plugins
$ cd /opt/kong/plugins/apig-response-transform
$ luarocks make
|
Configuration Reference
This plugin is compatible with requests with the following protocols:
This plugin is compatible with DB-less mode.
In DB-less mode, Kong Gateway does not have an Admin API. If using this
mode, configure the plugin using declarative configuration.
It is recommended to use in dbless mode.
Enabling the plugin on a service
Admin API
Kubernetes
Declarative (YAML)
For example, configure this plugin on a service by
making the following request:
1
2
3
| $ curl -X POST http://<admin-hostname>:8001/services/<service>/plugins \
--data "name=apig-response-transform" \
--data "config.format=xml"
|
<service>
is the id
or name
of the service that this plugin
configuration will target.
First, create a KongPlugin
resource:
1
2
3
4
5
6
7
| apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: <apig-response-transform-example>
config:
format: xml
plugin: apig-response-transform
|
Next, apply the KongPlugin resource to a
Service by annotating the
Service as follows:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
| apiVersion: v1
kind: Service
metadata:
name: <service>
labels:
app: <service>
annotations:
konghq.com/plugins: <apig-response-transform-example>
spec:
ports:
- port: 80
targetPort: 80
protocol: TCP
name: <service>
selector:
app: <service>
|
<service>
is the id
or name
of the service that this plugin
configuration will target.
Note: The KongPlugin resource only needs to be defined once
and can be applied to any service, consumer, or route in the namespace. If you
want the plugin to be available cluster-wide, create the resource as a
KongClusterPlugin
instead of KongPlugin
.
For example, configure this plugin on a service by
adding this section to your declarative configuration file:
1
2
3
4
5
| plugins:
- name: apig-response-transform
service: <service>
config:
format: xml
|
<service>
is the id
or name
of the service that this plugin
configuration will target.
Enabling the plugin on a route
Admin API
Kubernetes
Declarative (YAML)
For example, configure this plugin on a route with:
1
2
3
| $ curl -X POST http://<admin-hostname>:8001/routes/<route>/plugins \
--data "name=apig-response-transform" \
--data "config.format=xml"
|
<route>
is the id
or name
of the route that this plugin configuration
will target.
First, create a KongPlugin
resource:
1
2
3
4
5
6
7
| apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: <apig-response-transform-example>
config:
format: xml
plugin: apig-response-transform
|
Then, apply it to an ingress (Route or Routes)
by annotating the ingress as follows:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
| apiVersion: networking/v1beta1
kind: Ingress
metadata:
name: <route>
annotations:
kubernetes.io/ingress.class: kong
konghq.com/plugins: <apig-response-transform-example>
spec:
rules:
- host: examplehostname.com
http:
paths:
- path: /bar
backend:
serviceName: echo
servicePort: 80
|
<route>
is the id
or name
of the route that this plugin configuration
will target.
Note: The KongPlugin resource only needs to be defined once
and can be applied to any service, consumer, or route in the namespace. If you
want the plugin to be available cluster-wide, create the resource as a
KongClusterPlugin
instead of KongPlugin
.
For example, configure this plugin on a route by
adding this section to your declarative configuration file:
1
2
3
4
5
| plugins:
- name: apig-response-transform
route: <route>
config:
format: xml
|
<route>
is the id
or name
of the route that this plugin configuration
will target.
Enabling the plugin globally
A plugin which is not associated to any service, route, or consumer is
considered global, and will be run on every request. Read the
Plugin Reference and the Plugin Precedence
sections for more information.
Admin API
Kubernetes
Declarative (YAML)
For example, configure this plugin globally with:
1
2
3
| $ curl -X POST http://<admin-hostname>:8001/plugins/ \
--data "name=apig-response-transform" \
--data "config.format=xml"
|
Create a KongClusterPlugin
resource and label it as global:
1
2
3
4
5
6
7
8
9
10
11
| apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
name: <global-apig-response-transform>
annotations:
kubernetes.io/ingress.class: kong
labels:
global: \"true\"
config:
format: xml
plugin: apig-response-transform
|
For example, configure this plugin using the plugins:
entry in the declarative
configuration file:
1
2
3
4
| plugins:
- name: apig-response-transform
config:
format: xml
|
Parameters
Here's a list of all the parameters which can be used in this plugin's configuration:
Form Parameter | Description |
name
Type: string |
The name of the plugin to use, in this case apig-response-transform . |
service.id
Type: string |
The ID of the Service the plugin targets. |
route.id
Type: string |
The ID of the Route the plugin targets. |
enabled
Type: boolean
Default value: true |
Whether this plugin will be applied. |
config.format
required
Default value: xml
|
Describe the format of the response format.
|