How to Transform a JSON Message to SOAP¶
Let's consider a scenario where you have a SOAP-based backend and a JSON client. The SOAP backend is exposed as a REST API in the Micro Integrator.
When the JSON client sends a message to the SOAP backend, the REST API in the Micro Integrator should convert the JSON message to SOAP. The backend will process the SOAP request and generate a response for the JSON client. The Micro Integrator should then convert the SOAP response back to JSON and return it to the client.
The following examples explain different methods of converting JSON messages to SOAP using the Micro Integrator.
Using the PayloadFactory mediator¶
Let's convert JSON messages to SOAP using the PayloadFactory mediator.
Synapse configuration¶
Following is a sample REST API configuration that we can use to implement this scenario. See the instructions on how to build and run this example.
<?xml version="1.0" encoding="UTF-8"?>
<api context="/stockorder_api" name="JSONToSOAP" xmlns="http://ws.apache.org/ns/synapse">
<resource methods="GET POST PUT">
<inSequence>
<payloadFactory media-type="xml" template-type="default">
<format>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.samples" xmlns:xsd="http://services.samples/xsd">
<soapenv:Header/>
<soapenv:Body>
<ser:placeOrder>
<ser:order>
<xsd:symbol>$1</xsd:symbol>
<xsd:price>$2</xsd:price>
<xsd:quantity>$3</xsd:quantity>
</ser:order>
</ser:placeOrder>
</soapenv:Body>
</soapenv:Envelope>
</format>
<args>
<arg expression="$.placeOrder.order.symbol" evaluator="json"/>
<arg expression="$.placeOrder.order.price" evaluator="json"/>
<arg expression="$.placeOrder.order.quantity" evaluator="json"/>
</args>
</payloadFactory>
<log category="INFO" level="full"/>
<call>
<endpoint key="SimpleStockEp"/>
</call>
<property name="messageType" scope="axis2" type="STRING" value="application/json"/>
<respond/>
</inSequence>
<faultSequence>
</faultSequence>
</resource>
</api>
<?xml version="1.0" encoding="UTF-8"?>
<endpoint name="SimpleStockEp" xmlns="http://ws.apache.org/ns/synapse">
<address uri="http://localhost:9000/services/SimpleStockQuoteService">
<suspendOnFailure>
<initialDuration>-1</initialDuration>
<progressionFactor>1</progressionFactor>
</suspendOnFailure>
<markForSuspension>
<retriesBeforeSuspension>0</retriesBeforeSuspension>
</markForSuspension>
</address>
</endpoint>
Build and run (example 1)¶
Create the artifacts:
-
Launch Visual Studio Code with the Micro Integrator for VS Code extension (MI for VS Code) installed.
Info
Follow the Install Micro Integrator for VS Code documentation for a complete installation guide.
-
Create an integration project.
- Create the REST API with the configurations given above.
- Deploy the artifacts in your Micro Integrator.
Set up the backend service:
- Download the back-end service.
- Extract the downloaded zip file.
- Open a terminal, and navigate to the
axis2Server/bin/directory inside the extracted folder. -
Execute the following command to start the axis2server with the SimpleStockQuote backend service:
sh axis2server.shaxis2server.bat
Invoke the REST API:
- HTTP method:
POST - Request URL:
http://localhost:8290/stockorder_api - Content-Type:
application/json - SoapAction:
urn:placeOrder - Message Body:
{ "placeOrder": { "order": { "symbol": "IBM", "price": "3.141593E0", "quantity": "4" } } }
Check the log printed on the backend service's terminal to confirm that the order has been successfully placed.
Fri Aug 02 17:23:18 IST 2024 samples.services.SimpleStockQuoteService :: Accepted order #1 for : 4 stocks of IBM at $ 3.141593
The JSON client will receive a 202 response from the backend confirming that the stock order has been received.
Using the XSLT mediator¶
Let's convert JSON messages to SOAP using the XSLT mediator. The XSLT, which specifies the message conversion parameters, is stored in the product registry as a local entry.
Synapse configuration¶
Following are the synapse configurations for implementing this scenario. See the instructions on how to build and run this example.
<?xml version="1.0" encoding="UTF-8"?>
<api context="/stockorder_api" name="Convert_JSON_To_Soap_Using_XSLT" xmlns="http://ws.apache.org/ns/synapse">
<resource methods="GET POST">
<inSequence>
<log category="INFO" level="full"/>
<xslt key="in_transform"/>
<header name="Action" action="set" scope="default" value="urn:getQuote"/>
<enrich>
<source clone="true" type="custom" xpath="//m0:getQuote" xmlns:m0="http://services.samples"/>
<target action="replace" type="body"/>
</enrich>
<call>
<endpoint key="SimpleStockEp"/>
</call>
<property name="messageType" scope="axis2" type="STRING" value="application/json"/>
<respond/>
</inSequence>
<faultSequence>
</faultSequence>
</resource>
</api>
<?xml version="1.0" encoding="UTF-8"?>
<localEntry key="in_transform" xmlns="http://ws.apache.org/ns/synapse">
<xsl:stylesheet exclude-result-prefixes="m0 fn" version="2.0" xmlns:fn="http://www.w3.org/2005/02/xpath-functions" xmlns:m0="http://services.samples" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:output indent="yes" method="xml" omit-xml-declaration="yes"/>
<xsl:template match="*">
<xsl:element name="{local-name()}" namespace="http://services.samples">
<xsl:copy-of select="attribute::*"/>
<xsl:apply-templates/>
</xsl:element>
</xsl:template>
</xsl:stylesheet>
</localEntry>
<?xml version="1.0" encoding="UTF-8"?>
<endpoint name="SimpleStockEp" xmlns="http://ws.apache.org/ns/synapse">
<address format="soap11" uri="http://localhost:9000/services/SimpleStockQuoteService">
<suspendOnFailure>
<initialDuration>-1</initialDuration>
<progressionFactor>1</progressionFactor>
</suspendOnFailure>
<markForSuspension>
<retriesBeforeSuspension>0</retriesBeforeSuspension>
</markForSuspension>
</address>
</endpoint>
Build and run (example 2)¶
Create the artifacts:
-
Launch Visual Studio Code with the Micro Integrator for VS Code extension (MI for VS Code) installed.
Info
Follow the Install Micro Integrator for VS Code documentation for a complete installation guide.
-
Create an integration project.
- Create the REST API with the configurations given above.
- Create a local entry named in_transform with the above XSLT configuration.
- Deploy the artifacts in your Micro Integrator.
Set up the backend service:
- Download the back-end service.
- Extract the downloaded zip file.
- Open a terminal, and navigate to the
axis2Server/bin/directory inside the extracted folder. -
Execute the following command to start the axis2server with the SimpleStockQuote backend service:
sh axis2server.shaxis2server.bat
Invoke the REST API:
- HTTP method:
POST - Request URL:
http://localhost:8290/stockorder_api - Content-Type:
application/json - SoapAction:
urn:getQuote - Message Body:
{ "getQuote": { "request": { "symbol": "IBM" } } }
Check the log printed on the backend service's terminal to confirm that the request is successfully sent.
Thu Jul 04 09:57:03 IST 2024 samples.services.SimpleStockQuoteService :: Generating quote for : IBM
The JSON client will receive the following response from the backend with the relevant stock quote:
{
"getQuoteResponse": {
"return": {
"@type": "ax21:GetQuoteResponse",
"change": -2.7461458083948234,
"earnings": -8.902403847737537,
"high": -76.88947473390292,
"last": 78.48339950126588,
"lastTradeTimestamp": "Sat Aug 03 20:58:03 IST 2024",
"low": -76.7346372667833,
"marketCap": 35972151.03356741,
"name": "IBM Company",
"open": 82.08102633181527,
"peRatio": 24.115603872309407,
"percentageChange": 3.7576876965199992,
"prevClose": -73.08073555282505,
"symbol": "IBM",
"volume": 16540
}
}
}