Skip to content

Commit edecfc4

Browse files
committed
Merge branch 'main' into release-build-redis
2 parents 385fa57 + 5bb8fd4 commit edecfc4

File tree

264 files changed

+1772
-1433
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

264 files changed

+1772
-1433
lines changed
Lines changed: 52 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
11
---
2-
title: Tutorial - Publish versions of your API using Azure API Management
3-
description: Follow the steps of this tutorial to learn how to publish multiple API versions in API Management.
2+
title: Tutorial - Publish versions of an API using Azure API Management
3+
description: Learn how to publish multiple API versions in API Management.
44
author: dlepow
55

66
ms.service: azure-api-management
77
ms.custom: mvc, devx-track-azurecli
88
ms.topic: tutorial
9-
ms.date: 02/10/2021
9+
ms.date: 03/26/2025
1010
ms.author: danlep
11+
12+
#customer intent: As a developer, I want to publish mutliple versions of an API so that all callers to the API don't need to use the same version.
1113
---
12-
# Tutorial: Publish multiple versions of your API
14+
15+
# Tutorial: Publish multiple versions of your API
1316

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

16-
There are times when it's impractical to have all callers to your API use exactly the same version. When callers want to upgrade to a later version, they want an approach that's easy to understand. As shown in this tutorial, it's possible to provide multiple *versions* in Azure API Management.
19+
There are times when it's impractical to have all callers to your API use the same version. When callers want to upgrade to a later version, they want an approach that's easy to understand. As shown in this tutorial, it's possible to provide multiple *versions* in Azure API Management.
1720

18-
For background, see [Versions](api-management-versions.md) & [Revisions](api-management-revisions.md).
21+
For background, see [Versions](api-management-versions.md) and [Revisions](api-management-revisions.md).
1922

2023
[!INCLUDE [api-management-workspace-try-it](../../includes/api-management-workspace-try-it.md)]
2124

@@ -25,73 +28,71 @@ In this tutorial, you learn how to:
2528
> * Add a new version to an existing API
2629
> * Choose a version scheme
2730
> * Add the version to a product
28-
> * Browse the developer portal to see the version
31+
> * View the version in the developer portal
2932
30-
:::image type="content" source="media/api-management-get-started-publish-versions/azure-portal.png" alt-text="Screenshot showing API versions in the Azure portal.":::
33+
:::image type="content" source="media/api-management-get-started-publish-versions/azure-portal.png" alt-text="Screenshot showing API versions in the Azure portal." lightbox="media/api-management-get-started-publish-versions/azure-portal.png":::
3134

3235
## Prerequisites
3336

34-
+ Learn the [Azure API Management terminology](api-management-terminology.md).
35-
+ Complete the following quickstart: [Create an Azure API Management instance](get-started-create-service-instance.md).
36-
+ Also, complete the following tutorial: [Import and publish your first API](import-and-publish.md).
37+
+ Learn [Azure API Management terminology](api-management-terminology.md).
38+
+ Complete the quickstart [Create an Azure API Management instance](get-started-create-service-instance.md).
39+
+ Complete the tutorial [Import and publish your first API](import-and-publish.md).
3740

3841
## Add a new version
3942

4043
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
41-
1. Select **APIs**.
42-
1. Select **Swagger Petstore** from the API list.
43-
1. Select the context menu (**...**) next to **Swagger Petstore**.
44-
1. Select **Add version**.
45-
46-
:::image type="content" source="media/api-management-get-started-publish-versions/add-version-menu.png" alt-text="Screenshot showing command to add version in the API context menu in the portal.":::
44+
1. In the left menu, in the **APIs** section, select **APIs**.
45+
1. Locate **Swagger Petstore - OpenAPI 3.0** in the API list. Select the ellipsis (**...**) next to **Swagger Petstore - OpenAPI 3.0** and then select **Add version**. You'll add values to the resulting window in the next section.
4746

47+
:::image type="content" source="media/api-management-get-started-publish-versions/add-version-menu.png" alt-text="Screenshot showing the steps for adding a version." lightbox="media/api-management-get-started-publish-versions/add-version-menu.png":::
4848

4949
> [!TIP]
50-
> Versions can also be enabled when you create a new API. On the **Add API** screen, select **Version this API?**.
50+
> You can also enable versions when you create a new API. On the **Add API** screen, select **Version this API?**.
5151
5252
## Choose a versioning scheme
5353

54-
In Azure API Management, you choose how callers specify the API version by selecting a *versioning scheme*: **path, header**, or **query string**. In the following example, *path* is used as the versioning scheme.
55-
56-
Enter the values from the following table. Then select **Create** to create your version.
57-
58-
:::image type="content" source="media/api-management-get-started-publish-versions/add-version.png" alt-text="Screenshot showing window to create a new version in the portal.":::
59-
54+
In API Management, you choose how callers specify the API version by selecting a *versioning scheme*: **Path**, **Header**, or **Query string**. In the following example, *Path* is used as the versioning scheme.
6055

56+
In the **Create a new API as a version** window, enter the values from the following table. Then select **Create** to create your version.
6157

6258
|Setting |Value |Description |
6359
|---------|---------|---------|
6460
|**Version identifier** | *v1* | Scheme-specific indicator of the version. For **Path**, the suffix for the API URL path. |
65-
|**Versioning scheme** | **Path** | The way callers specify the API version.<br/><br/> If **Header** or **Query string** is selected, enter another value: the name of the header or query string parameter.<br/><br/> A usage example is displayed. |
66-
|**Full API version name** | *swagger-petstore-v1* | Unique name in your API Management instance.<br/><br/>Because a version is in fact a new API based off an API's [revision](api-management-get-started-revise-api.md), this setting is the new API's name. |
67-
|**Products** | **Unlimited** (provided in certain service tiers) | Optionally, one or more products that the API version is associated with. To publish the API, you must associate it with a product. You can also [add the version to a product](#add-the-version-to-a-product) later. |
61+
|**Versioning scheme** | **Path** | The way callers specify the API version.<br/><br/> If you select **Header** or **Query string**, enter another value: the name of the header or query string parameter.<br/><br/> A usage example is displayed. |
62+
|**Full API version name** | *swagger-petstore-openapi-3-0-v1* | Unique name in your API Management instance.<br/><br/>Because a version is actually a new API that's based on an API's [revision](api-management-get-started-revise-api.md), this value is the new API's name. |
63+
|**Products** | **Unlimited** (provided in some service tiers) | Optionally, one or more products that the API version is associated with. To publish the API, you must associate it with a product. You can also [add the version to a product](#add-the-version-to-a-product) later. |
64+
65+
:::image type="content" source="media/api-management-get-started-publish-versions/add-version.png" alt-text="Screenshot showing window to create a new version in the portal." lightbox="media/api-management-get-started-publish-versions/add-version.png":::
6866

69-
After creating the version, it now appears underneath **Swagger Petstore** in the API List. You now see two APIs: **Original**, and **v1**.
67+
After you create the version, it appears under **Swagger Petstore - OpenAPI 3.0** in the API list. You now see two APIs: **Original** and **v1**:
7068

71-
:::image type="content" source="media/api-management-get-started-publish-versions/version-list.png" alt-text="Screenshot of versions listed under API in the portal.":::
69+
:::image type="content" source="media/api-management-get-started-publish-versions/version-list.png" alt-text="Screenshot that shows the list of versions." lightbox="media/api-management-get-started-publish-versions/version-list.png":::
7270

7371
> [!Note]
74-
> If you add a version to a non-versioned API, an **Original** is also automatically created. This version responds on the default URL. Creating an Original version ensures that any existing callers are not broken by the process of adding a version. If you create a new API with versions enabled at the start, an Original isn't created.
72+
> If you add a version to a non-versioned API, an original version is also automatically created. This version responds on the default URL. The original version ensures that calls from existing callers still work after the version is added. If you create a new API with versions enabled at the start, an original isn't created.
7573
7674
## Edit a version
7775

78-
After adding the version, you can now edit and configure it as an API that is separate from an Original. Changes to one version don't affect another. For example, add or remove API operations, or edit the OpenAPI specification. For more information, see [Edit an API](edit-api.md).
76+
After you add the version, you can edit and configure it as an API that's separate from the original. Changes to one version don't affect another (for example, if you add or remove API operations, or edit the OpenAPI specification). For more information, see [Edit an API](edit-api.md).
7977

8078
## Add the version to a product
8179

82-
In order for callers to see the new version, it must be added to a *product*. If you didn't already add the version to a product, you can add it to a product at any time.
80+
For callers to see the new version, it must be added to a *product*. If you didn't already add the version to a product, you can do so at any time.
81+
82+
To add the version to a product:
8383

84-
For example, to add the version to the **Unlimited** product:
8584
1. In the Azure portal, navigate to your API Management instance.
86-
1. Select **Products** > **Unlimited** > **APIs** > **+ Add**.
87-
1. Select **Swagger Petstore**, version **v1**.
88-
1. Click **Select**.
85+
1. Under **APIs** in the left pane, select **Products**.
86+
1. Select the product, and then select **APIs** in the left pane.
87+
1. Select **+ Add**.
88+
1. Select the API.
89+
1. Click **Select**.
8990

90-
:::image type="content" source="media/api-management-get-started-publish-versions/08-add-multiple-versions-03-add-version-product.png" alt-text="Screenshot of adding version to product in the portal.":::
91+
:::image type="content" source="media/api-management-get-started-publish-versions/08-add-multiple-versions-03-add-version-product.png" alt-text="Screenshot that shows the APIs - Product window." lightbox="media/api-management-get-started-publish-versions/08-add-multiple-versions-03-add-version-product.png":::
9192

9293
## Use version sets
9394

94-
When you create multiple versions, the Azure portal creates a *version set*, which represents a set of versions for a single logical API. Select the name of an API that has multiple versions. The Azure portal displays its **Version set**. You can customize the **Name** and **Description** of a virtual set.
95+
When you create multiple versions, the Azure portal creates a *version set*, which represents a set of versions for a single logical API. If you select the name of an API that has multiple versions, the portal displays its version set. You can customize the name and description of a version set.
9596

9697
You can interact directly with version sets by using the Azure CLI:
9798

@@ -100,42 +101,34 @@ You can interact directly with version sets by using the Azure CLI:
100101
To see all your version sets, run the [az apim api versionset list](/cli/azure/apim/api/versionset#az-apim-api-versionset-list) command:
101102

102103
```azurecli
103-
az apim api versionset list --resource-group apim-hello-world-resource-group \
104-
--service-name apim-hello-world --output table
104+
az apim api versionset list --resource-group <resource-group-name> \
105+
--service-name <API-Management-service-name> --output table
105106
```
106107

107108
When the Azure portal creates a version set for you, it assigns an alphanumeric name, which appears in the **Name** column of the list. Use this name in other Azure CLI commands.
108109

109110
To see details about a version set, run the [az apim api versionset show](/cli/azure/apim/api/versionset#az-apim-api-versionset-show) command:
110111

111112
```azurecli
112-
az apim api versionset show --resource-group apim-hello-world-resource-group \
113-
--service-name apim-hello-world --version-set-id 00000000000000000000000
113+
az apim api versionset show --resource-group <resource-group-name> \
114+
--service-name <API-Management-service-name> --version-set-id <ID from the Name column>
114115
```
115116

116117
For more information about version sets, see [Versions in Azure API Management](api-management-versions.md#how-versions-are-represented).
117118

118-
## Browse the developer portal to see the version
119-
120-
If you've tried the [developer portal](api-management-howto-developer-portal-customize.md), you can see API versions there.
121-
122-
1. Select **Developer Portal** from the top menu.
123-
2. Select **APIs**, and then select **Swagger Petstore**.
124-
3. You should see a dropdown with multiple versions next to the API name.
125-
4. Select **v1**.
126-
5. Notice the **Request URL** of the first operation in the list. It shows that the API URL path includes **v1**.
119+
## View the version in the developer portal
127120

128-
## Next steps
121+
If you use the [developer portal](api-management-howto-developer-portal-customize.md), you can see API versions there.
129122

130-
In this tutorial, you learned how to:
123+
1. Select **Developer portal** at the top of the window.
124+
1. Select **APIs**, and then select **Swagger Petstore**.
125+
1. You should see a dropdown that lists multiple versions next to the API name.
126+
1. Select **v1**.
127+
1. Notice the **Request URL** of the first operation in the list. It shows that the API URL path includes **v1**.
131128

132-
> [!div class="checklist"]
133-
> * Add a new version to an existing API
134-
> * Choose a version scheme
135-
> * Add the version to a product
136-
> * Browse the developer portal to see the version
129+
## Next step
137130

138-
Advance to the next tutorial:
131+
Go to the next tutorial:
139132

140133
> [!div class="nextstepaction"]
141134
> [Customize the style of the Developer portal pages](api-management-howto-developer-portal-customize.md)
Loading
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

0 commit comments

Comments
 (0)