It is used to convert JSON data coming from or returning to the client into a different format.
If this policy is used in the request line (Client → API Proxy → API), the message body from the client is transformed and transmitted to the Backend API.
If it is used in the response line (API → API Proxy → Client), the result is transmitted to the client by applying transformation on the message body returned from the Backend API.
The use of this policy makes sense if the message body from the client is JSON.
Apinizer uses the Jolt library for JSON conversions. For detailed information, you can visit the Jolt page.
The picture below shows the policy settings:
The policy fields are shown in the table below.
Field
Description
Name
The name can be written to facilitate the use and management of the policy. You will need this name during the management and selection of policies.
Description
An optional description of the policy that may be useful for usage and management activities.
Message Type
The message type can be selected as JSON to JSON or JSON to XML.
Jolt Value
Jolt script required for conversion is entered.
For detailed information on how to test Jolt scripts written for message transformation, you can visit the JSON Transformer page.
You can visit thePoliciespage for the details of theConditionsandError Message Customizationpanels.