Follow these steps to configure the XML to JSON policy for DataPower® API Gateway in the assembly
user interface.
About this task
This topic describes how to configure the policy in the assembly user interface; for details on
how to configure the policy in your OpenAPI source, see xml-to-json.
Procedure
-
In the navigation pane, click
Develop, then select the APIs tab.
The Develop page
opens.
- Click the title of the API that you want to work with, or create a new API.
- Select the Gateway tab, then click
Policies in the navigation pane.
For more information about
working with the assembly editor for an API, see
The assembly editor.
- Find the XML to JSON policy in the palette, and drag the policy onto your canvas.
- Specify the following properties.
Table 1. XML to JSON policy
properties
Property label |
Required |
Description |
Data type |
Title |
Yes |
The title of the policy. The default value is xml-to-json .
|
string |
Description |
No |
A description of the policy. |
string |
Input |
No |
The input message to convert. Specify the name of a variable in the API context.
variableName.body , the message payload, represents the XML input
to convert. The default value of the variable is message and
message.body is the default input. |
string |
Output |
No |
The output message to store the conversion result. Specify the name of a variable in the API
context. variableName.body represents the result of conversion
from XML format to JSON format. When the specified input message is the default message, the default
output is message.body . Otherwise, when the input message is the variable
my-message-variable , for example, the default output is
my-message-variable.body .The variable cannot be any read-only in the API
context.
|
string |
Conversion type |
No |
The conversion type that determines the target format of the output. The following options
are available:
- badgerFish: BadgerFish convention is used to determine the target
conversion format of the output.
- apicv5: apicv5 convention is used to determine the target conversion
format of the output.
|
string |
- Specify a version for the policy by clicking the Source icon
,
and completing the
version
section of the policy YAML. For
example: execute:
- xml-to-json:
version: 2.0.0
title: xml-to-json
...
You must specify a version for the policy that is compatible with the gateway that
you are using. When the API is published, if the version is incompatible with the gateway, a
validation error is thrown that specifies the available versions.
- Click Save.
Example
For example, the following simple XML
object
<a>hello</a>
becomes
{ "a": { "$" : "hello" } }
The following XML object with an
attribute
<a type="world">hello</a>
becomes
{ "a": { "$" : "hello", "@type" : "world" } }
For more examples, see xml-to-json.