Import a SOAP API and convert to REST

This article shows how to import a SOAP API and convert it to REST. The article also shows how to test the APIM API.

In this article, you learn how to:

  • Import a SOAP API and convert to REST
  • Test the API in the Azure portal
  • Test the API in the Developer portal


Complete the following quickstart: Create an Azure API Management instance

Go to your API Management instance

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

    Select API Management services

  2. On the API Management screen, select your API Management instance.

    Select your API Management instance

Import and publish a back-end API

  1. Select APIs from under API MANAGEMENT.

  2. Select WSDL from the Add a new API list.


  3. In the WSDL specification, enter the URL to where your SOAP API resides.

  4. Click SOAP to REST radio button. When this option is clicked, APIM attempts to make an automatic transformation between XML and JSON. In this case consumers should be calling the API as a restful API, which returns JSON. APIM is converting each request into a SOAP call.

    SOAP to REST

  5. Press tab.

    The following fields get filled up with the info from the SOAP API: Display name, Name, Description.

  6. Add an API URL suffix. The suffix is a name that identifies this specific API in this APIM instance. It has to be unique in this APIM instance.

  7. Publish the API by associating the API with a product. In this case, the "Unlimited" product is used. If you want for the API to be published and be available to developers, add it to a product. You can do it during API creation or set it later.

    Products are associations of one or more APIs. You can include a number of APIs and offer them to developers through the developer portal. Developers must first subscribe to a product to get access to the API. When they subscribe, they get a subscription key that is good for any API in that product. If you created the APIM instance, you are an administrator already, so you are subscribed to every product by default.

    By default, each API Management instance comes with two sample products:

    • Starter
    • Unlimited
  8. Select Create.

Test the new API in the Azure portal

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

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

  2. Press the Test tab.

  3. 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 APIM instance, you are an administrator already, so the key is filled in automatically.

  4. Press Send.

    Backend responds with 200 OK and some data.

Append other APIs

An API can be composed of APIs exposed by different services, including the OpenAPI Specification, a SOAP API, the API Apps feature of Azure App Service, Azure Function App, Azure Logic Apps, and Azure Service Fabric.

Import an API

To append a different API to your existing API, complete the following steps. When you import another API, the operations are appended to your current API.

  1. Go to your Azure API Management instance in the Azure portal.
  2. Select APIs from the menu on the left.
  3. Click ... next to the API that you want to append another API to.
  4. Select Import from the drop-down menu.
  5. Select a service from which to import an API.

Next steps