Datakit: Transform JSON into XML and back - Plugin

Transform JSON into XML and back

Use the Datakit plugin to transform JSON request bodies into XML before sending them to an external service, then convert the XML response back into JSON.

This example contains the following nodes:

The node JSON_XML converts the incoming JSON request body into XML format.
The node CALL sends the XML data to an external SOAP API.
The node XML_JSON converts the XML response from the external SOAP API back into JSON format and sets it as the response body.

Set up the plugin

Add this section to your kong.yaml configuration file:

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: datakit
    config:
      debug: true
      nodes:
      - name: JSON_XML
        type: json_to_xml
        attributes_block_name: "#attr"
        input: request.body
      - name: CALL
        type: call
        url: http://localhost:7180
        method: POST
        inputs:
          body: JSON_XML
      - name: XML_JSON
        type: xml_to_json
        input: CALL.body
        attributes_block_name: "#attr"
        output: response.body

Make the following request:

curl -i -X POST http://localhost:8001/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "datakit",
      "config": {
        "debug": true,
        "nodes": [
          {
            "name": "JSON_XML",
            "type": "json_to_xml",
            "attributes_block_name": "#attr",
            "input": "request.body"
          },
          {
            "name": "CALL",
            "type": "call",
            "url": "http://localhost:7180",
            "method": "POST",
            "inputs": {
              "body": "JSON_XML"
            }
          },
          {
            "name": "XML_JSON",
            "type": "xml_to_json",
            "input": "CALL.body",
            "attributes_block_name": "#attr",
            "output": "response.body"
          }
        ]
      },
      "tags": []
    }
    '

Copied!

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "datakit",
      "config": {
        "debug": true,
        "nodes": [
          {
            "name": "JSON_XML",
            "type": "json_to_xml",
            "attributes_block_name": "#attr",
            "input": "request.body"
          },
          {
            "name": "CALL",
            "type": "call",
            "url": "http://localhost:7180",
            "method": "POST",
            "inputs": {
              "body": "JSON_XML"
            }
          },
          {
            "name": "XML_JSON",
            "type": "xml_to_json",
            "input": "CALL.body",
            "attributes_block_name": "#attr",
            "output": "response.body"
          }
        ]
      },
      "tags": []
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: datakit
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/tags: ''
  labels:
    global: 'true'
config:
  debug: true
  nodes:
  - name: JSON_XML
    type: json_to_xml
    attributes_block_name: '#attr'
    input: request.body
  - name: CALL
    type: call
    url: http://localhost:7180
    method: POST
    inputs:
      body: JSON_XML
  - name: XML_JSON
    type: xml_to_json
    input: CALL.body
    attributes_block_name: '#attr'
    output: response.body
plugin: datakit
" | kubectl apply -f -

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_datakit" "my_datakit" {
  enabled = true

  config = {
    debug = true
    nodes = [
      {
        name = "JSON_XML"
        type = "json_to_xml"
        attributes_block_name = "#attr"
        input = "request.body"
      }, 

      {
        name = "CALL"
        type = "call"
        url = "http://localhost:7180"
        method = "POST"

        inputs = {
          body = "JSON_XML"
        }
      }, 

      {
        name = "XML_JSON"
        type = "xml_to_json"
        input = "CALL.body"
        attributes_block_name = "#attr"
        output = "response.body"
      }    ]
  }
  tags = []

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}

Copied!

Add this section to your kong.yaml configuration file:

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: datakit
    service: serviceName|Id
    config:
      debug: true
      nodes:
      - name: JSON_XML
        type: json_to_xml
        attributes_block_name: "#attr"
        input: request.body
      - name: CALL
        type: call
        url: http://localhost:7180
        method: POST
        inputs:
          body: JSON_XML
      - name: XML_JSON
        type: xml_to_json
        input: CALL.body
        attributes_block_name: "#attr"
        output: response.body

Make sure to replace the following placeholders with your own values:

serviceName|Id: The id or name of the service the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "datakit",
      "config": {
        "debug": true,
        "nodes": [
          {
            "name": "JSON_XML",
            "type": "json_to_xml",
            "attributes_block_name": "#attr",
            "input": "request.body"
          },
          {
            "name": "CALL",
            "type": "call",
            "url": "http://localhost:7180",
            "method": "POST",
            "inputs": {
              "body": "JSON_XML"
            }
          },
          {
            "name": "XML_JSON",
            "type": "xml_to_json",
            "input": "CALL.body",
            "attributes_block_name": "#attr",
            "output": "response.body"
          }
        ]
      },
      "tags": []
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

serviceName|Id: The id or name of the service the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "datakit",
      "config": {
        "debug": true,
        "nodes": [
          {
            "name": "JSON_XML",
            "type": "json_to_xml",
            "attributes_block_name": "#attr",
            "input": "request.body"
          },
          {
            "name": "CALL",
            "type": "call",
            "url": "http://localhost:7180",
            "method": "POST",
            "inputs": {
              "body": "JSON_XML"
            }
          },
          {
            "name": "XML_JSON",
            "type": "xml_to_json",
            "input": "CALL.body",
            "attributes_block_name": "#attr",
            "output": "response.body"
          }
        ]
      },
      "tags": []
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.
serviceId: The id of the service the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: datakit
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/tags: ''
config:
  debug: true
  nodes:
  - name: JSON_XML
    type: json_to_xml
    attributes_block_name: '#attr'
    input: request.body
  - name: CALL
    type: call
    url: http://localhost:7180
    method: POST
    inputs:
      body: JSON_XML
  - name: XML_JSON
    type: xml_to_json
    input: CALL.body
    attributes_block_name: '#attr'
    output: response.body
plugin: datakit
" | kubectl apply -f -

Copied!

Next, apply the KongPlugin resource by annotating the service resource:

kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=datakit

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_datakit" "my_datakit" {
  enabled = true

  config = {
    debug = true
    nodes = [
      {
        name = "JSON_XML"
        type = "json_to_xml"
        attributes_block_name = "#attr"
        input = "request.body"
      }, 

      {
        name = "CALL"
        type = "call"
        url = "http://localhost:7180"
        method = "POST"

        inputs = {
          body = "JSON_XML"
        }
      }, 

      {
        name = "XML_JSON"
        type = "xml_to_json"
        input = "CALL.body"
        attributes_block_name = "#attr"
        output = "response.body"
      }    ]
  }
  tags = []

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  service = {
    id = konnect_gateway_service.my_service.id
  }
}

Copied!

Add this section to your kong.yaml configuration file:

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: datakit
    route: routeName|Id
    config:
      debug: true
      nodes:
      - name: JSON_XML
        type: json_to_xml
        attributes_block_name: "#attr"
        input: request.body
      - name: CALL
        type: call
        url: http://localhost:7180
        method: POST
        inputs:
          body: JSON_XML
      - name: XML_JSON
        type: xml_to_json
        input: CALL.body
        attributes_block_name: "#attr"
        output: response.body

Make sure to replace the following placeholders with your own values:

routeName|Id: The id or name of the route the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "datakit",
      "config": {
        "debug": true,
        "nodes": [
          {
            "name": "JSON_XML",
            "type": "json_to_xml",
            "attributes_block_name": "#attr",
            "input": "request.body"
          },
          {
            "name": "CALL",
            "type": "call",
            "url": "http://localhost:7180",
            "method": "POST",
            "inputs": {
              "body": "JSON_XML"
            }
          },
          {
            "name": "XML_JSON",
            "type": "xml_to_json",
            "input": "CALL.body",
            "attributes_block_name": "#attr",
            "output": "response.body"
          }
        ]
      },
      "tags": []
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

routeName|Id: The id or name of the route the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "datakit",
      "config": {
        "debug": true,
        "nodes": [
          {
            "name": "JSON_XML",
            "type": "json_to_xml",
            "attributes_block_name": "#attr",
            "input": "request.body"
          },
          {
            "name": "CALL",
            "type": "call",
            "url": "http://localhost:7180",
            "method": "POST",
            "inputs": {
              "body": "JSON_XML"
            }
          },
          {
            "name": "XML_JSON",
            "type": "xml_to_json",
            "input": "CALL.body",
            "attributes_block_name": "#attr",
            "output": "response.body"
          }
        ]
      },
      "tags": []
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.
routeId: The id of the route the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: datakit
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/tags: ''
config:
  debug: true
  nodes:
  - name: JSON_XML
    type: json_to_xml
    attributes_block_name: '#attr'
    input: request.body
  - name: CALL
    type: call
    url: http://localhost:7180
    method: POST
    inputs:
      body: JSON_XML
  - name: XML_JSON
    type: xml_to_json
    input: CALL.body
    attributes_block_name: '#attr'
    output: response.body
plugin: datakit
" | kubectl apply -f -

Copied!

Next, apply the KongPlugin resource by annotating the httproute or ingress resource:

kubectl annotate -n kong httproute  konghq.com/plugins=datakit

Copied!

kubectl annotate -n kong ingress  konghq.com/plugins=datakit

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_datakit" "my_datakit" {
  enabled = true

  config = {
    debug = true
    nodes = [
      {
        name = "JSON_XML"
        type = "json_to_xml"
        attributes_block_name = "#attr"
        input = "request.body"
      }, 

      {
        name = "CALL"
        type = "call"
        url = "http://localhost:7180"
        method = "POST"

        inputs = {
          body = "JSON_XML"
        }
      }, 

      {
        name = "XML_JSON"
        type = "xml_to_json"
        input = "CALL.body"
        attributes_block_name = "#attr"
        output = "response.body"
      }    ]
  }
  tags = []

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  route = {
    id = konnect_gateway_route.my_route.id
  }
}

Copied!

Add this section to your kong.yaml configuration file:

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: datakit
    consumer: consumerName|Id
    config:
      debug: true
      nodes:
      - name: JSON_XML
        type: json_to_xml
        attributes_block_name: "#attr"
        input: request.body
      - name: CALL
        type: call
        url: http://localhost:7180
        method: POST
        inputs:
          body: JSON_XML
      - name: XML_JSON
        type: xml_to_json
        input: CALL.body
        attributes_block_name: "#attr"
        output: response.body

Make sure to replace the following placeholders with your own values:

consumerName|Id: The id or name of the consumer the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/consumers/{consumerName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "datakit",
      "config": {
        "debug": true,
        "nodes": [
          {
            "name": "JSON_XML",
            "type": "json_to_xml",
            "attributes_block_name": "#attr",
            "input": "request.body"
          },
          {
            "name": "CALL",
            "type": "call",
            "url": "http://localhost:7180",
            "method": "POST",
            "inputs": {
              "body": "JSON_XML"
            }
          },
          {
            "name": "XML_JSON",
            "type": "xml_to_json",
            "input": "CALL.body",
            "attributes_block_name": "#attr",
            "output": "response.body"
          }
        ]
      },
      "tags": []
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

consumerName|Id: The id or name of the consumer the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/{consumerId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "datakit",
      "config": {
        "debug": true,
        "nodes": [
          {
            "name": "JSON_XML",
            "type": "json_to_xml",
            "attributes_block_name": "#attr",
            "input": "request.body"
          },
          {
            "name": "CALL",
            "type": "call",
            "url": "http://localhost:7180",
            "method": "POST",
            "inputs": {
              "body": "JSON_XML"
            }
          },
          {
            "name": "XML_JSON",
            "type": "xml_to_json",
            "input": "CALL.body",
            "attributes_block_name": "#attr",
            "output": "response.body"
          }
        ]
      },
      "tags": []
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.
consumerId: The id of the consumer the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: datakit
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/tags: ''
config:
  debug: true
  nodes:
  - name: JSON_XML
    type: json_to_xml
    attributes_block_name: '#attr'
    input: request.body
  - name: CALL
    type: call
    url: http://localhost:7180
    method: POST
    inputs:
      body: JSON_XML
  - name: XML_JSON
    type: xml_to_json
    input: CALL.body
    attributes_block_name: '#attr'
    output: response.body
plugin: datakit
" | kubectl apply -f -

Copied!

Next, apply the KongPlugin resource by annotating the KongConsumer resource:

kubectl annotate -n kong kongconsumer CONSUMER_NAME konghq.com/plugins=datakit

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_datakit" "my_datakit" {
  enabled = true

  config = {
    debug = true
    nodes = [
      {
        name = "JSON_XML"
        type = "json_to_xml"
        attributes_block_name = "#attr"
        input = "request.body"
      }, 

      {
        name = "CALL"
        type = "call"
        url = "http://localhost:7180"
        method = "POST"

        inputs = {
          body = "JSON_XML"
        }
      }, 

      {
        name = "XML_JSON"
        type = "xml_to_json"
        input = "CALL.body"
        attributes_block_name = "#attr"
        output = "response.body"
      }    ]
  }
  tags = []

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  consumer = {
    id = konnect_gateway_consumer.my_consumer.id
  }
}

Copied!

Add this section to your kong.yaml configuration file:

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: datakit
    consumer_group: consumerGroupName|Id
    config:
      debug: true
      nodes:
      - name: JSON_XML
        type: json_to_xml
        attributes_block_name: "#attr"
        input: request.body
      - name: CALL
        type: call
        url: http://localhost:7180
        method: POST
        inputs:
          body: JSON_XML
      - name: XML_JSON
        type: xml_to_json
        input: CALL.body
        attributes_block_name: "#attr"
        output: response.body

Make sure to replace the following placeholders with your own values:

consumerGroupName|Id: The id or name of the consumer group the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/consumer_groups/{consumerGroupName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "datakit",
      "config": {
        "debug": true,
        "nodes": [
          {
            "name": "JSON_XML",
            "type": "json_to_xml",
            "attributes_block_name": "#attr",
            "input": "request.body"
          },
          {
            "name": "CALL",
            "type": "call",
            "url": "http://localhost:7180",
            "method": "POST",
            "inputs": {
              "body": "JSON_XML"
            }
          },
          {
            "name": "XML_JSON",
            "type": "xml_to_json",
            "input": "CALL.body",
            "attributes_block_name": "#attr",
            "output": "response.body"
          }
        ]
      },
      "tags": []
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

consumerGroupName|Id: The id or name of the consumer group the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{consumerGroupId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "datakit",
      "config": {
        "debug": true,
        "nodes": [
          {
            "name": "JSON_XML",
            "type": "json_to_xml",
            "attributes_block_name": "#attr",
            "input": "request.body"
          },
          {
            "name": "CALL",
            "type": "call",
            "url": "http://localhost:7180",
            "method": "POST",
            "inputs": {
              "body": "JSON_XML"
            }
          },
          {
            "name": "XML_JSON",
            "type": "xml_to_json",
            "input": "CALL.body",
            "attributes_block_name": "#attr",
            "output": "response.body"
          }
        ]
      },
      "tags": []
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.
consumerGroupId: The id of the consumer group the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: datakit
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/tags: ''
config:
  debug: true
  nodes:
  - name: JSON_XML
    type: json_to_xml
    attributes_block_name: '#attr'
    input: request.body
  - name: CALL
    type: call
    url: http://localhost:7180
    method: POST
    inputs:
      body: JSON_XML
  - name: XML_JSON
    type: xml_to_json
    input: CALL.body
    attributes_block_name: '#attr'
    output: response.body
plugin: datakit
" | kubectl apply -f -

Copied!

Next, apply the KongPlugin resource by annotating the KongConsumerGroup resource:

kubectl annotate -n kong kongconsumergroup CONSUMERGROUP_NAME konghq.com/plugins=datakit

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_datakit" "my_datakit" {
  enabled = true

  config = {
    debug = true
    nodes = [
      {
        name = "JSON_XML"
        type = "json_to_xml"
        attributes_block_name = "#attr"
        input = "request.body"
      }, 

      {
        name = "CALL"
        type = "call"
        url = "http://localhost:7180"
        method = "POST"

        inputs = {
          body = "JSON_XML"
        }
      }, 

      {
        name = "XML_JSON"
        type = "xml_to_json"
        input = "CALL.body"
        attributes_block_name = "#attr"
        output = "response.body"
      }    ]
  }
  tags = []

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  consumer_group = {
    id = konnect_gateway_consumer_group.my_consumer_group.id
  }
}

Copied!

Datakit

Transform JSON into XML and back

Set up the plugin

Help us make these docs great!

Still need help