Edit

Share via

Import a SOAP API to API Management and convert it to REST

  • Article

APPLIES TO: All API Management tiers

This article shows how to import a SOAP API as a WSDL specification and then convert it to a REST API. It also shows how to test the API in Azure API Management.

In this article, you learn how to:

  • Import a SOAP API and convert it to REST
  • 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

Go to your API Management instance

  1. In the Azure portal, search for and select API Management services:

    Screenshot that shows API Management services in the search results.

  2. On the API Management services page, select your API Management instance:

    Screenshot that shows an API Management instance on the API Management services page.

Import and publish a backend API

  1. In the left pane, in the APIs section, select APIs.

  2. On the APIs page, select + Add API.

  3. Under Create from definition, select WSDL:

    Screenshot that shows the WSDL tile in the Azure portal.

  4. In WSDL specification, enter the URL to your SOAP API, or click Select a file to select a local WSDL file.

  5. Under Import method, select SOAP to REST. When this option is selected, API Management attempts to make an automatic transformation between XML and JSON. In this case, consumers should call the API as a RESTful API, which returns JSON. API Management converts each request to a SOAP call.

    Screenshot that shows the SOAP to REST option.

  6. The Display name and Name boxes are filled automatically with information from the SOAP API.

    Display name, URL, and Description information is automatically entered for operations. Operations also receive a system-generated Name.

  7. Enter other API settings, and then select Create. You can also configure these values later by going to the Settings tab.

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

Test the new API in the Azure portal

You can call operations directly from the Azure portal. This method provides a convenient way to view and test the operations of an API.

  1. Select the API you created in the previous step.

  2. Select the Test tab.

  3. Select an operation.

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

  4. Select Send.

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

Append other APIs

You can compose an API out of APIs that are exposed by different services, including:

  • An OpenAPI specification
  • A SOAP API
  • A GraphQL API
  • A Web App that's hosted in Azure App Service
  • Azure Functions
  • Azure Logic Apps
  • Azure Service Fabric

Note

When you import an API, the operations are appended to your current API.

To append an API to an existing API:

  1. Go to your Azure API Management instance in the Azure portal:

    Screenshot that shows the API Management services page.

  2. Select APIs on the Overview page or select APIs > APIs in the menu on the left.

    Screenshot that shows the APIs selection on the Overview page.

  3. Select the ellipsis (...) next to the API that you want to append another API to.

  4. Select Import from the drop-down menu:

    Screenshot that shows the Import command.

  5. Select a service from which to import an API.

Related content