Skip to content

Commit efeb928

Browse files
authored
Merge pull request #296803 from v-albemi/import-soap-api
AI Freshness Edit: Azure API Management
2 parents e8c70df + bce1ca7 commit efeb928

File tree

5 files changed

+53
-47
lines changed

5 files changed

+53
-47
lines changed
28.8 KB
Loading

articles/api-management/restify-soap-api.md

Lines changed: 29 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,69 @@
11
---
2-
title: Import SOAP API to Azure API Management and convert to REST using the portal | Microsoft Docs
3-
description: Learn how to import a SOAP API to Azure API Management as a WSDL specification and convert it to a REST API. Then, test the API in the Azure portal.
2+
title: Import a SOAP API to Azure API Management and convert it to REST using the portal | Microsoft Docs
3+
description: Learn how to import a SOAP API into Azure API Management as a WSDL specification and convert it to a REST API. Then test the API in the Azure portal.
44
services: api-management
55
author: dlepow
66
ms.custom: devdivchpfy22
77
ms.service: azure-api-management
88
ms.topic: how-to
9-
ms.date: 03/29/2022
9+
ms.date: 03/27/2025
1010
ms.author: danlep
1111

12+
#customer intent: As a developer, I want to import a SOAP API into API Management and convert it to REST.
13+
1214
---
13-
# Import SOAP API to API Management and convert to REST
15+
# Import a SOAP API to API Management and convert it to REST
1416

1517
[!INCLUDE [api-management-availability-all-tiers](../../includes/api-management-availability-all-tiers.md)]
1618

17-
This article shows how to import a SOAP API as a WSDL specification and then convert it to a REST API. The article also shows how to test the API in API Management.
19+
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.
1820

1921
In this article, you learn how to:
2022

2123
> [!div class="checklist"]
22-
> * Import a SOAP API and convert to REST
24+
> * Import a SOAP API and convert it to REST
2325
> * Test the API in the Azure portal
2426
2527
[!INCLUDE [api-management-wsdl-import](../../includes/api-management-wsdl-import.md)]
2628

2729
## Prerequisites
2830

29-
Complete the following quickstart: [Create an Azure API Management instance](get-started-create-service-instance.md)
31+
- Complete the quickstart [Create an Azure API Management instance](get-started-create-service-instance.md).
3032

3133
[!INCLUDE [api-management-navigate-to-instance.md](../../includes/api-management-navigate-to-instance.md)]
3234

33-
## <a name="create-api"> </a>Import and publish a back-end API
35+
## <a name="create-api"> </a>Import and publish a backend API
36+
37+
1. In the left pane, in the **APIs** section, select **APIs**.
38+
1. On the APIs page, select **+ Add API**.
39+
1. Under **Create from definition**, select **WSDL**:
3440

35-
1. From the left menu, under the **APIs** section, select **APIs** > **+ Add API**.
36-
1. Under **Create from definition**, select **WSDL**.
41+
:::image type="content" source="./media/restify-soap-api/wsdl-api.png" alt-text="Screenshot that shows the WSDL tile in the Azure portal.":::
3742

38-
![SOAP API](./media/restify-soap-api/wsdl-api.png)
39-
1. In **WSDL specification**, enter the URL to your SOAP API, or select **Select a file** to select a local WSDL file.
40-
1. In **Import method**, select **SOAP to REST**.
43+
1. In **WSDL specification**, enter the URL to your SOAP API, or click **Select a file** to select a local WSDL file.
44+
1. Under **Import method**, select **SOAP to REST**.
4145
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.
4246

43-
![SOAP to REST](./media/restify-soap-api/soap-to-rest.png)
47+
:::image type="content" source="./media/restify-soap-api/soap-to-rest.png" alt-text="Screenshot that shows the SOAP to REST option." lightbox="./media/restify-soap-api/soap-to-rest.png":::
4448

45-
1. The following fields are filled automatically with information from the SOAP API: **Display name**, **Name**, **Description**. Operations are filled automatically with **Display name**, **URL**, and **Description**, and receive a system-generated **Name**.
46-
1. Enter other API settings. You can set the values during creation or configure them later by going to the **Settings** tab.
49+
1. The **Display name** and **Name** boxes are filled automatically with information from the SOAP API.
50+
51+
**Display name**, **URL**, and **Description** information is automatically entered for operations. Operations also receive a system-generated **Name**.
52+
1. Enter other API settings, and then select **Create**. You can also configure these values later by going to the **Settings** tab.
4753

48-
For more information about API settings, see [Import and publish your first API](import-and-publish.md#import-and-publish-a-backend-api) tutorial.
49-
1. Select **Create**.
54+
For more information about API settings, see [Import and publish your first API](import-and-publish.md#import-and-publish-a-backend-api).
5055

5156
## Test the new API in the Azure portal
5257

53-
Operations can be called directly from the Azure portal, which provides a convenient way to view and test the operations of an API.
58+
You can call operations directly from the Azure portal. This method provides a convenient way to view and test the operations of an API.
5459

5560
1. Select the API you created in the previous step.
56-
2. Select the **Test** tab.
57-
3. Select an operation.
61+
1. Select the **Test** tab.
62+
1. Select an operation.
63+
64+
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.
5865

59-
The page shows 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 admin already, so the key is filled in automatically.
60-
1. Press **Send**.
66+
1. Select **Send**.
6167

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

includes/api-management-append-apis.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,38 +2,38 @@
22
author: vladvino
33
ms.service: azure-api-management
44
ms.topic: include
5-
ms.date: 04/16/2021
5+
ms.date: 03/27/2025
66
ms.author: vlvinogr
77
---
88
## Append other APIs
99

10-
You can compose an API of APIs exposed by different services, including:
10+
You can compose an API out of APIs that are exposed by different services, including:
11+
1112
* An OpenAPI specification
1213
* A SOAP API
1314
* A GraphQL API
14-
* A Web App hosted in Azure App Service
15-
* Azure Function App
15+
* A Web App that's hosted in Azure App Service
16+
* Azure Functions
1617
* Azure Logic Apps
1718
* Azure Service Fabric
1819

19-
Append a different API to your existing API using the following steps.
20-
2120
>[!NOTE]
22-
> When you import another API, the operations are appended to your current API.
21+
> When you import an API, the operations are appended to your current API.
2322
24-
1. Go to your Azure API Management instance in the Azure portal.
23+
To append an API to an existing API:
2524

26-
:::image type="content" source="./media/api-management-append-apis/service-page-1.png" alt-text="Screenshot of navigating to API Management instance in the portal.":::
25+
1. Go to your Azure API Management instance in the Azure portal:
2726

28-
1. Select **APIs** on the **Overview** page or from the menu on the left.
27+
:::image type="content" source="./media/api-management-append-apis/service-page-1.png" alt-text="Screenshot that shows the API Management services page." lightbox="./media/api-management-append-apis/service-page-1.png":::
2928

30-
:::image type="content" source="./media/api-management-append-apis/api-select-1.png" alt-text="Screenshot of selecting APIs on Overview page in the portal.":::
29+
1. Select **APIs** on the **Overview** page or select **APIs** > **APIs** in the menu on the left.
3130

32-
1. Click **...** next to the API that you want to append another API to.
33-
1. Select **Import** from the drop-down menu.
31+
:::image type="content" source="./media/api-management-append-apis/api-select-1.png" alt-text="Screenshot that shows the APIs selection on the Overview page." lightbox="./media/api-management-append-apis/api-select-1.png":::
3432

35-
:::image type="content" source="./media/api-management-append-apis/append-02.png" alt-text="Select import":::
33+
1. Select the ellipsis (**...**) next to the API that you want to append another API to.
3634

37-
1. Select a service from which to import an API.
35+
1. Select **Import** from the drop-down menu:
3836

39-
:::image type="content" source="./media/api-management-append-apis/select-to-import.png" alt-text="Screenshot of selecting a service in the portal.":::
37+
:::image type="content" source="./media/api-management-append-apis/append-02.png" alt-text="Screenshot that shows the Import command." lightbox="./media/api-management-append-apis/append-02.png":::
38+
39+
1. Select a service from which to import an API.

includes/api-management-define-api-topics.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ ms.author: danlep
1212
* [API import limitations](../articles/api-management/api-management-api-import-restrictions.md)
1313
* [Import an OpenAPI specification](../articles/api-management/import-api-from-oas.md)
1414
* [Import a SOAP API](../articles/api-management/import-soap-api.md)
15-
* [Import a SOAP API and convert to REST](../articles/api-management/restify-soap-api.md)
15+
* [Import a SOAP API and convert it to REST](../articles/api-management/restify-soap-api.md)
1616
* [Import an App Service API](../articles/api-management/import-app-service-as-api.md)
1717
* [Import a Container App API](../articles/api-management/import-container-app-with-oas.md)
1818
* [Import a WebSocket API](../articles/api-management/websocket-api.md)
1919
* [Import a GraphQL API](../articles/api-management/graphql-api.md)
2020
* [Import a GraphQL schema and set up field resolvers](../articles/api-management/graphql-schema-resolve-api.md)
21-
* [Import an Azure Function App](../articles/api-management/import-function-app-as-api.md)
22-
* [Import an Azure Logic App](../articles/api-management/import-logic-app-as-api.md)
21+
* [Import an Azure Function App API](../articles/api-management/import-function-app-as-api.md)
22+
* [Import an Azure Logic App API](../articles/api-management/import-logic-app-as-api.md)
2323
* [Import a Service Fabric service](/azure/service-fabric/service-fabric-tutorial-deploy-api-management)
2424
* [Import an Azure OpenAI API](../articles/api-management/azure-openai-api-from-specification.md)
2525
* [Import an OData API](../articles/api-management/import-api-from-odata.md)

includes/api-management-navigate-to-instance.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
author: dlepow
33
ms.service: azure-api-management
44
ms.topic: include
5-
ms.date: 04/16/2021
5+
ms.date: 03/27/2025
66
ms.author: danlep
77
---
88
## Go to your API Management instance
99

10-
1. In the Azure [portal](https://portal.azure.com), search for and select **API Management services**.
10+
1. In the Azure [portal](https://portal.azure.com), search for and select **API Management services**:
1111

12-
:::image type="content" source="media/api-management-navigate-to-instance/view-apim-1.png" alt-text="Select API Management services":::
12+
:::image type="content" source="media/api-management-navigate-to-instance/view-apim-1.png" alt-text="Screenshot that shows API Management services in the search results." lightbox="media/api-management-navigate-to-instance/view-apim-1.png":::
1313

14-
1. On the **API Management services** page, select your API Management instance.
14+
1. On the **API Management services** page, select your API Management instance:
1515

16-
:::image type="content" source="media/api-management-navigate-to-instance/view-apim-new.png" alt-text="Select your API Management instance":::
16+
:::image type="content" source="media/api-management-navigate-to-instance/view-apim-new.png" alt-text="Screenshot that shows an API Management instance on the API Management services page." lightbox="media/api-management-navigate-to-instance/view-apim-new.png":::

0 commit comments

Comments
 (0)