Skip to content

How to Transform Content Types

This section describes how you can transform the content type of a message using an API. In this scenario, the API exposes a REST back-end service that accepts and returns XML and JSON messages for HTTP methods as follows:

  • GET - Response is in JSON format.
  • POST - Accepts JSON request and returns response in XML format.
  • DELETE - Empty request body is required. Returns response in XML format.

Synapse configuration

Following is a sample REST API configuration that we can used to implement this scenario. See the instructions on how to build and run this example.

<api xmlns="http://ws.apache.org/ns/synapse" name="HealthcareService" context="/healthcare">
    <resource methods="POST" url-mapping="/appointment/reserve">
        <inSequence>
            <property name="REST_URL_POSTFIX" scope="axis2" action="remove"/>
            <call>
                <endpoint key="GrandOaks" />
            </call>
            <log level="full"/>
            <property name="messageType" value="application/xml" scope="axis2"/>
            <respond/>
        </inSequence>
    </resource>
    <resource methods="GET" uri-template="/appointments/{appointmentNo}">
        <inSequence>
            <call>
                <endpoint key="HealthCare" />
            </call>
            <log level="full"/>
            <property name="messageType" value="application/json" scope="axis2"/>
            <respond/>
        </inSequence>
    </resource>
    <resource methods="DELETE" uri-template="/appointments/{appointmentNo}">
        <inSequence>
            <call>
                <endpoint key="HealthCare" />
            </call>
            <log level="full"/>
            <property name="messageType" value="application/xml" scope="axis2"/>
            <respond/>
        </inSequence>
    </resource>
</api>
<endpoint name="GrandOaks" xmlns="http://ws.apache.org/ns/synapse">
    <address uri="http://localhost:9090/grandoaks/categories/surgery/reserve"/>
</endpoint>
<endpoint name="HealthCare" xmlns="http://ws.apache.org/ns/synapse">
    <address uri="http://localhost:9090/healthcare"/>
</endpoint>

Build and run

Create the artifacts:

  1. Launch Visual Studio Code with the WSO2 Integrator: MI for VS Code extension (MI for VS Code) installed.

    Info

    Follow the Install WSO2 Integrator: MI for VS Code documentation for a complete installation guide.

  2. Create an integration project.

  3. Create the rest API with the configurations given above.
  4. Deploy the artifacts in your WSO2 Integrator: MI.

Set up the back-end service:

  1. Download the Hospital-Service-2.0.0-JDK11.jar.
  2. Open a terminal, navigate to the location of the downloaded service, and run it using the following command:

    java -jar Hospital-Service-2.0.0-JDK11.jar
    

Sending an HTTP POST request:

  1. Create the request.json file as follows:

    {
        "patient": {
        "name": "John Doe",
        "dob": "1940-03-19",
        "ssn": "234-23-525",
        "address": "California",
        "phone": "8770586755",
        "email": "[email protected]"
        },
        "doctor": "thomas collins",
        "hospital": "grand oak community hospital",
        "appointment_date": "2025-04-02"
    }
    

  2. Following is the cURL command to send an HTTP POST request to the API:

    Tip

    The context of the API is ‘/healthcare’. For every HTTP method, a url-mapping or uri-template is defined, and the URL to call the methods differ with the defined mapping or template.

    curl -v -H "Content-Type: application/json" -X POST -d @request.json http://localhost:8290/healthcare/appointment/reserve
    

    The response from backend to the WSO2 Integrator: MI will be:

    {
       "appointmentNumber": 1,
       "doctor": {
          "name": "thomas collins",
          "hospital": "grand oak community hospital",
          "category": "surgery",
          "availability": "9.00 a.m - 11.00 a.m",
          "fee": 7000
       },
       "patient": {
          "name": "John Doe",
          "dob": "1940-03-19",
          "ssn": "234-23-525",
          "address": "California",
          "phone": "8770586755",
          "email": "[email protected]"
       },
       "fee": 7000,
       "confirmed": false,
       "appointmentDate": "2025-04-02"
    }
    

    The WSO2 Integrator: MI transform the response to XML and send it back to client as:

    <jsonObject>
       <appointmentNumber>1</appointmentNumber>
       <doctor>
          <name>thomas collins</name>
          <hospital>grand oak community hospital</hospital>
          <category>surgery</category>
          <availability>9.00 a.m - 11.00 a.m</availability>
          <fee>7000.0</fee>
       </doctor>
       <patient>
          <name>John Doe</name>
          <dob>1940-03-19</dob>
          <ssn>234-23-525</ssn>
          <address>California</address>
          <phone>8770586755</phone>
          <email>[email protected]</email>
       </patient>
       <fee>7000.0</fee>
       <confirmed>false</confirmed>
       <appointmentDate>2025-04-02</appointmentDate>
    </jsonObject>
    

Sending an HTTP GET request:

  1. Following is the CURL command to send a GET request to the API:

    curl -v -X GET http://localhost:8290/healthcare/appointments/1
    
  2. The response for the request will be:

    {
       "appointmentNumber": 1,
       "doctor": {
          "name": "thomas collins",
          "hospital": "grand oak community hospital",
          "category": "surgery",
          "availability": "9.00 a.m - 11.00 a.m",
          "fee": 7000
       },
       "patient": {
          "name": "John Doe",
          "dob": "1940-03-19",
          "ssn": "234-23-525",
          "address": "California",
          "phone": "8770586755",
          "email": "[email protected]"
       },
       "fee": 7000,
       "confirmed": false,
       "appointmentDate": "2025-04-02"
    }
    

Sending an HTTP DELETE request:

  1. Following is the cURL command for sending an HTTP DELETE request:

    curl -v -X DELETE http://localhost:8290/healthcare/appointments/1
    

    This request will be sent to the back end, and the order with the specified ID will be deleted. The response to the WSO2 Integrator: MI from backend will be as follows:

    {"status":"Appointment is successfully removed"}
    
  2. The WSO2 Integrator: MI transform the response to XML and sends it back to the client as follows:

    <jsonObject><status>Appointment is successfully removed</status></jsonObject>