Import SOAP API to API Management

Artiklu
03/03/2022
3 minuti biex taqra

This article shows how to import a WSDL specification, which is a standard XML representation of a SOAP API. The article also shows how to test the API in API Management.

In this article, you learn how to:

Import a SOAP API
Test the API in the Azure portal

Note

WSDL import to API Management is subject to certain limitations. WSDL files with wsdl:import, xsd:import, and xsd:include directives aren't supported. For an open-source tool to resolve and merge these dependencies in a WSDL file, see this GitHub repo.

Prerequisites

Complete the following quickstart: Create an Azure API Management instance

Go to your API Management instance

In the Azure portal, search for and select API Management services.
On the API Management services page, select your API Management instance.

Import and publish a backend API

From the left menu, under the APIs section, select APIs > + Add API.
Under Create from definition, select WSDL.
In WSDL specification, enter the URL to your SOAP API, or click Select a file to select a local WSDL file.
In Import method, SOAP pass-through is selected by default. With this selection, the API is exposed as SOAP, and API consumers have to use SOAP rules. If you want to "restify" the API, follow the steps in Import a SOAP API and convert it to REST.
The following fields are filled automatically with information from the SOAP API: Display name, Name, Description.
Enter other API settings. You can set the values during creation or configure them later by going to the Settings tab.

For more information about API settings, see Import and publish your first API tutorial.
Select Create.

Test the new API in the portal

Operations can be called directly from the portal, which provides a convenient way to view and test the operations of an API.

Select the API you created in the previous step.
Press the Test tab.
Select some operation.

The page displays fields for query parameters and fields for the headers. One of the headers is Ocp-Apim-Subscription-Key, for the subscription key of the product that is associated with this API. If you created the API Management instance, you're an administrator already, so the key is filled in automatically.
Press Send.

When the test is successful, the backend responds with 200 OK and some data.

Wildcard SOAP action

If you need to pass a SOAP request that doesn't have a dedicated action defined in the API, you can configure a wildcard SOAP action. The wildcard action will match any SOAP request that isn't defined in the API.

To define a wildcard SOAP action:

In the portal, select the API you created in the previous step.
In the Design tab, select + Add Operation.
Enter a Display name for the operation.
In the URL, select POST and enter /soapAction={any} in the resource. The template parameter inside the curly brackets is arbitrary and doesn't affect the execution.