Inspur Request Transformer plugin

Community Plugin: This plugin is developed, tested, and maintained by a third-party contributor.

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.

Installation

Recommended:

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

Configuration Reference

This plugin is compatible with DB-less mode.

It is recommended to use in dbless mode.

Example plugin configuration

Enable on a service

Enable on a route

Enable globally

The following examples provide some typical configurations for enabling the apig-request-transformer plugin on a service.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/services/SERVICE_NAME|SERVICE_ID/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"

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: apig-request-transformer-example
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
plugin: apig-request-transformer

Next, apply the KongPlugin resource to a service by annotating the service as follows:

apiVersion: v1
kind: Service
metadata:
  name: SERVICE_NAME|SERVICE_ID
  labels:
    app: SERVICE_NAME|SERVICE_ID
  annotations:
    konghq.com/plugins: apig-request-transformer-example
spec:
  ports:
  - port: 80
    targetPort: 80
    protocol: TCP
    name: SERVICE_NAME|SERVICE_ID
  selector:
    app: SERVICE_NAME|SERVICE_ID

Replace SERVICE_NAME|SERVICE_ID with 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.

Add this section to your declarative configuration file:

plugins:
- name: apig-request-transformer
  service: SERVICE_NAME|SERVICE_ID
  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

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

The following examples provide some typical configurations for enabling the apig-request-transformer plugin on a route.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/routes/ROUTE_NAME|ROUTE_ID/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"

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: apig-request-transformer-example
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
plugin: apig-request-transformer

Then, apply it to an ingress (route or routes) by annotating the ingress as follows:

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: ROUTE_NAME|ROUTE_ID
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/plugins: apig-request-transformer-example
spec:
  rules:
  - host: examplehostname.com
    http:
      paths:
      - path: /bar
        backend:
          service:
            name: echo
            port:
              number: 80

Replace ROUTE_NAME|ROUTE_ID with 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.

Add this section to your declarative configuration file:

plugins:
- name: apig-request-transformer
  route: ROUTE_NAME
  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

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

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.

The following examples provide some typical configurations for enabling the apig-request-transformer plugin globally.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/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"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-apig-request-transformer>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: \"true\"
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
plugin: apig-request-transformer

Add a plugins entry in the declarative configuration file:

plugins:
- name: apig-request-transformer
  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

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

Form Parameter	Description
`name` required Type: string	The name of the plugin, in this case `apig-request-transformer`.
`service.name` or `service.id` Type: string	The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level `/plugins` endpoint. Not required if using `/services/SERVICE_NAME\|SERVICE_ID/plugins`.
`route.name` or `route.id` Type: string	The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level `/plugins` endpoint. Not required if using `/routes/ROUTE_NAME\|ROUTE_ID/plugins`.
`enabled` Type: boolean Default value: `true`	Whether this plugin will be applied.
`config.httpMethod` required	Changes the HTTP method for the upstream request.
`config.backendContentType` optional	Changes Content-Type for the upstream request.
`config.requestPath` optional	It is used with [config.pathParams] to extract values from the request URI.
`config.backendPath` optional	Updates the the path part of the upstream request URI with values.
`config.pathParams` semi-optional	List of parameters’ names of the request URI.
`config.replace` optional	List of parameter mappings. Replace its old value with the new one at different locations.
`config.add` optional	List of constant parameters. Set a new header or a new querystring with the given value.

About this Plugin
Made by	Inspur
Categories	Transformations
DB-less compatible?	Yes
Compatible protocols	`http` `https`
Support	github.com
Source	Code License (Apache-2.0)