...
- Sign in to the API Cloud. You will be navigated to the API Publisher. Click ADD NEW API, which is under the API menu.
- Select I Have a SOAP Endpoint. You see the following two options to create APIs for SOAP backend.
- Pass Through – Create a pass through proxy for SOAP requests coming to the API Gateway.
- Generate REST APIs – This option is used to generate REST API definitions from the given WSDL URL.
Info Select WSDL URL to provide a URL for your API. Alternatively, you can upload a WSDL archive/file
Select Generate REST APIs (The default option is Pass Through). Provide the WSDL URL given below for the SOAP backend and click Start Creating.
Code Block title Sample WSDL URL http://ws.cdyne.com/phoneverify/phoneverify.asmx?wsdl
Click on Edit Source to edit the Swagger specification of the API.
The automatically generated REST resources of the API appears.
You can describe your REST API better by modifying the Open API Specification that you see on this page. The following is a sample of how this particular API has been described.
Optionally, update the Swagger definition of your API and click Apply Changes to save your API.
Let's update the API by replacing the existing Swagger definition with the following Swagger definition.Expand title Expand to see the edited Swagger definition... Code Block swagger: "2.0" paths: /checkPhoneNumber: get: operationId: CheckPhoneNumber parameters: - in: query name: PhoneNumber required: true type: string - in: query name: LicenceKey required: true type: string responses: default: description: "" schema: $ref: "#/definitions/checkPhoneNumberOutput" x-wso2-soap: soap-action: "http://ws.cdyne.com/PhoneVerify/query/CheckPhoneNumber" soap-operation: CheckPhoneNumber namespace: "http://ws.cdyne.com/PhoneVerify/query" x-soap-version: "1.2" /checkPhoneNumbers: post: operationId: CheckPhoneNumbers parameters: - in: body name: Payload required: true schema: $ref: "#/definitions/checkPhoneNumbersInput" responses: default: description: "" schema: $ref: "#/definitions/checkPhoneNumbersOutput" x-wso2-soap: soap-action: "http://ws.cdyne.com/PhoneVerify/query/CheckPhoneNumbers" soap-operation: CheckPhoneNumbers namespace: "http://ws.cdyne.com/PhoneVerify/query" x-soap-version: "1.2" info: title: PhoneVerificationAPI version: 1.0.0 definitions: checkPhoneNumberInput: type: object properties: CheckPhoneNumber: $ref: "#/definitions/CheckPhoneNumber" checkPhoneNumberOutput: type: object properties: CheckPhoneNumberResponse: $ref: "#/definitions/CheckPhoneNumberResponse" checkPhoneNumbersInput: type: object properties: CheckPhoneNumbers: $ref: "#/definitions/CheckPhoneNumbers" checkPhoneNumbersOutput: type: object properties: CheckPhoneNumbersResponse: $ref: "#/definitions/CheckPhoneNumbersResponse" StringArray: type: string properties: String: type: array items: type: string xml: namespace: "http://www.w3.org/2001/XMLSchema" prefix: s CheckPhoneNumber: type: object properties: PhoneNumber: type: string LicenseKey: type: string xml: namespace: "http://www.w3.org/2001/XMLSchema" prefix: s CheckPhoneNumbersResponse: type: object properties: CheckPhoneNumbersResult: $ref: "#/definitions/ArrayOfPhoneReturn" xml: namespace: "http://www.w3.org/2001/XMLSchema" prefix: s ArrayOfString: type: object properties: string: type: array items: type: string xml: namespace: "http://www.w3.org/2001/XMLSchema" prefix: s ArrayOfPhoneReturn: type: object xml: namespace: "http://www.w3.org/2001/XMLSchema" prefix: s CheckPhoneNumbers: type: object properties: PhoneNumbers: $ref: "#/definitions/ArrayOfString" LicenseKey: type: string xml: namespace: "http://www.w3.org/2001/XMLSchema" prefix: s PhoneReturn: type: object xml: namespace: "http://www.w3.org/2001/XMLSchema" prefix: s CheckPhoneNumberResponse: type: object properties: CheckPhoneNumberResult: $ref: "#/definitions/PhoneReturn" xml: namespace: "http://www.w3.org/2001/XMLSchema" prefix: s
The generated API definitions are added to the API as shown below.
Note A REST API method is mapped with the corresponding SOAP operation through a Swagger, vendor-specific field -
x-wso2-soap. Note that this should not be edited. A parameter without this field cannot be mapped with a SOAP backend operation.See the sample REST operation given below.
Code Block /checkPhoneNumber: post: operationId: CheckPhoneNumber parameters: ... x-wso2-soap: soap-action: "http://ws.cdyne.com/PhoneVerify/query/CheckPhoneNumber" soap-operation: CheckPhoneNumber namespace: "http://ws.cdyne.com/PhoneVerify/query" x-soap-version: "1.2"The
operationIdparameter is used to map the REST resource with the corresponding SOAP operation.Edit the details of the API as shown below.
Field Sample value Name PhoneVerification Context /phoneverifyVersion 1.0.0 Access Control All Visibility on Store Public Tags phone
For more information on the meanings of the latter mentioned fields, see Create and Publish an API.
- Go to the Implement tab. Click on Managed API.
Select the Endpoint Type as the HTTP/SOAP Endpoint. Enter the SOAP endpoint URL given below.
Code Block title SOAP Endpoint URL http://ws.cdyne.com/phoneverify/phoneverify.asmx
Navigate to the SOAP to REST Mapping section. Click on a resource to view the In and Out sequences of the API.
The following is a sample Synapse based XML configuration which reads some parameters from the request path and constructs the SOAP payload required for the backend (target) services.The incoming JSON message parameters are stored using properties. The SOAP payload needed for the backend is generated using a payload factory mediator.
Code Block <header description="SOAPAction" name="SOAPAction" scope="transport" value="http://ws.cdyne.com/PhoneVerify/query/CheckPhoneNumber"/> <property name="REST_URL_POSTFIX" scope="axis2" action="remove"/> <property expression="$url:PhoneNumber" name="req.var.PhoneNumber"/> <property expression="$url:LicenceKey" name="req.var.LicenceKey"/> <payloadFactory description="transform" media-type="xml"> <format> <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope" xmlns:web="http://ws.cdyne.com/PhoneVerify/query"> <soapenv:Header/> <soapenv:Body> <web:CheckPhoneNumber xmlns:web="http://ws.cdyne.com/PhoneVerify/query"> <web:PhoneNumber>$1</web:PhoneNumber> <web:LicenceKey>$2</web:LicenceKey> </web:CheckPhoneNumber> </soapenv:Body> </soapenv:Envelope> </format> <args> <arg evaluator="xml" expression="get-property('req.var.PhoneNumber')"/> <arg evaluator="xml" expression="get-property('req.var.LicenceKey')"/> </args> </payloadFactory> <property description="messageProperty" name="messageType" scope="axis2" type="STRING" value="application/soap+xml"/>- Click Next and go to the Manage tab and select the throttling tiers for the API. Click Publish to publish the API to the API Store.
For instructions, see Create and Publish an API. Navigate to the API cloud Store (https://api.cloud.wso2.com/store/) and subscribe to the API.
After generating the production and sandbox keys you receive a valid access token to test the API.Run the following HTTP request to invoke the API.
You receive the actual backend response.Localtabgroup Localtab active true id curl title cURL command Code Block title HTTP Request curl -k -X GET "https://gateway.api.cloud.wso2.com:443/t/<tenant space><tenant>/phoneverify/1.0.0/checkPhoneNumber?PhoneNumber=1234567&LicenceKey=0" -H "accept: application/json" -H "Authorization: Bearer <access-token>"
Localtab id example title Example Code Block curl -k -X GET "https://gateway.api.cloud.wso2.com:443/t/shani6052/phoneverify/1.0.0/checkPhoneNumber?PhoneNumber=1234567&LicenceKey=0" -H "accept: application/json" -H "Authorization: Bearer f952e212-5247-3ae4-a974-20105068ac87"
Localtab id response title Response Code Block {"CheckPhoneNumberResponse":{"CheckPhoneNumberResult":{"Valid":false,"OriginalNumber":1234567,"CleanNumber":234567,"Wireless":false}}}