Inspur Request Transformer

Transform the request sent by a client on the fly on Kong, before hitting the upstream server.

The plugin implements parameter transformations and additions of various positions.

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.
• upstream service: this refers to your own API/service sitting behind Kong, to which client requests are forwarded.

Configuration

This plugin is compatible with requests with the following protocols:

• http
• https

This plugin is compatible with DB-less mode.

Enabling the plugin on a Service

With a database

Configure this plugin on a Service by making the following request:

$ curl -X POST http://kong:8001/services/{service}/plugins \
    --data "name=apig-request-transformer"  \
    --data "config.httpMethod=POST" \
    --data "config.backendContentType=application/json" \
    --data "config.requestPath=/requestPath/[pageId]/[userId]" \
    --data "config.backendPath=/servicePath/[pageId]/[userId]" \
    --data "config.pathParams=pageId" \
    --data "config.pathParams=userId" \
    --data "config.replace=head:h1;query:param1" \
    --data "config.replace=path:pageId;query:param2" \
    --data "config.add=head:h1:v1" \
    --data "config.add=query:param1:value1"

Without a database

Configure this plugin on a Service by adding this section do your declarative configuration file:

plugins:
- name: apig-request-transformer
  service: {service}
  config: 
    httpMethod: POST
    backendContentType: application/json
    requestPath: /requestPath/[pageId]/[userId]
    backendPath: /servicePath/[pageId]/[userId]
    pathParams:
    - pageId
    - userId
    replace:
    - head:h1;query:param1
    - path:pageId;query:param2
    add:
    - head:h1:v1
    - query:param1:value1

In both cases, {service} is the id or name of the Service that this plugin configuration will target.

Enabling the plugin on a Route

With a database

Configure this plugin on a Route with:

$ curl -X POST http://kong:8001/routes/{route}/plugins \
    --data "name=apig-request-transformer"  \
    --data "config.httpMethod=POST" \
    --data "config.backendContentType=application/json" \
    --data "config.requestPath=/requestPath/[pageId]/[userId]" \
    --data "config.backendPath=/servicePath/[pageId]/[userId]" \
    --data "config.pathParams=pageId" \
    --data "config.pathParams=userId" \
    --data "config.replace=head:h1;query:param1" \
    --data "config.replace=path:pageId;query:param2" \
    --data "config.add=head:h1:v1" \
    --data "config.add=query:param1:value1"

Without a database

Configure this plugin on a Route by adding this section do your declarative configuration file:

plugins:
- name: apig-request-transformer
  route: {route}
  config: 
    httpMethod: POST
    backendContentType: application/json
    requestPath: /requestPath/[pageId]/[userId]
    backendPath: /servicePath/[pageId]/[userId]
    pathParams:
    - pageId
    - userId
    replace:
    - head:h1;query:param1
    - path:pageId;query:param2
    add:
    - head:h1:v1
    - query:param1:value1

In both cases, {route} is the id or name of the Route that this plugin configuration will target.

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:

Installation

Recommended:

$ git clone https://github.com/cheriL/apig-request-transformer /opt/kong/plugins 
$ cd /opt/kong/plugins/apig-request-transformer 
$ luarocks make