You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 is possible to provide multiple *versions* in Azure API Management.
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.
17
17
18
18
For background, see [Versions](api-management-versions.md) & [Revisions](api-management-revisions.md).
19
19
@@ -25,7 +25,7 @@ In this tutorial, you learn how to:
25
25
> * Add the version to a product
26
26
> * Browse the developer portal to see the version
27
27
28
-
:::image type="content" source="media/api-management-getstarted-publish-versions/azure-portal.png" alt-text="Version shown in Azure portal":::
28
+
:::image type="content" source="media/api-management-get-started-publish-versions/azure-portal.png" alt-text="Screenshot showing API versions in the Azure portal.":::
29
29
30
30
## Prerequisites
31
31
@@ -37,11 +37,11 @@ In this tutorial, you learn how to:
37
37
38
38
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
39
39
1. Select **APIs**.
40
-
1. Select **Demo Conference API** from the API list.
41
-
1. Select the context menu (**...**) next to **Demo Conference API**.
40
+
1. Select **Swagger Petstore** from the API list.
41
+
1. Select the context menu (**...**) next to **Swagger Petstore**.
42
42
1. Select **Add version**.
43
43
44
-
:::image type="content" source="media/api-management-getstarted-publish-versions/add-version-menu.png" alt-text="API context menu - add version":::
44
+
:::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.":::
45
45
46
46
47
47
> [!TIP]
@@ -53,27 +53,27 @@ In Azure API Management, you choose how callers specify the API version by selec
53
53
54
54
Enter the values from the following table. Then select **Create** to create your version.
55
55
56
-
:::image type="content" source="media/api-management-getstarted-publish-versions/add-version.png" alt-text="Add version window":::
56
+
:::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.":::
57
57
58
58
59
59
60
60
|Setting |Value |Description |
61
61
|---------|---------|---------|
62
-
|**Name**|*demo-conference-api-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. |
63
-
|**Versioning scheme**|**Path**| The way callers specify the API version. |
64
-
|**Version identifier**|*v1*|Scheme-specific indicator of the version. For **Path**, the suffix for the API URL path. <br/><br/> If **Header** or **Query string**is selected, enter an additional value: the name of the header or query string parameter.<br/><br/> A usage example is displayed. |
65
-
|**Products**|**Unlimited**| 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. |
62
+
|**Version identifier**|*v1*|Scheme-specific indicator of the version. For **Path**, the suffix for the API URL path.|
63
+
|**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. |
64
+
|**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.|
65
+
|**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. |
66
66
67
-
After creating the version, it now appears underneath **Demo Conference API** in the API List. You now see two APIs: **Original**, and **v1**.
67
+
After creating the version, it now appears underneath **Swagger Petstore** in the API List. You now see two APIs: **Original**, and **v1**.
68
68
69
-

69
+
:::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.":::
70
70
71
71
> [!Note]
72
72
> 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.
73
73
74
74
## Edit a version
75
75
76
-
After adding the version, you can now edit and configure it as an API that is separate from an Original. Changes to one version do not 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 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).
77
77
78
78
## Add the version to a product
79
79
@@ -82,10 +82,10 @@ In order for callers to see the new version, it must be added to a *product*. If
82
82
For example, to add the version to the **Unlimited** product:
83
83
1. In the Azure portal, navigate to your API Management instance.
1. Select **Demo Conference API**, version **v1**.
85
+
1. Select **Swagger Petstore**, version **v1**.
86
86
1. Click **Select**.
87
87
88
-
:::image type="content" source="media/api-management-getstarted-publish-versions/08-add-multiple-versions-03-add-version-product.png" alt-text="Add version to product":::
88
+
:::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.":::
89
89
90
90
## Use version sets
91
91
@@ -118,7 +118,7 @@ For more information about version sets, see [Versions in Azure API Management](
118
118
If you've tried the [developer portal](api-management-howto-developer-portal-customize.md), you can see API versions there.
119
119
120
120
1. Select **Developer Portal** from the top menu.
121
-
2. Select **APIs**, and then select **Demo Conference API**.
121
+
2. Select **APIs**, and then select **Swagger Petstore**.
122
122
3. You should see a dropdown with multiple versions next to the API name.
123
123
4. Select **v1**.
124
124
5. Notice the **Request URL** of the first operation in the list. It shows that the API URL path includes **v1**.
0 commit comments