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
Copy file name to clipboardExpand all lines: articles/api-management/api-management-versions.md
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,7 @@ ms.topic: article
10
10
ms.date: 10/31/2021
11
11
ms.author: danlep
12
12
---
13
+
13
14
# Versions in Azure API Management
14
15
15
16
Versions allow you to present groups of related APIs to your developers. You can use versions to handle breaking changes in your API safely. Clients can choose to use your new API version when they're ready, while existing clients continue to use an older version. Versions are differentiated through a version identifier (which is any string value you choose), and a versioning scheme allows clients to identify which version of an API they want to use.
@@ -52,6 +53,9 @@ The format of an API request URL when using query string-based versioning is: `h
52
53
53
54
For example, `https://apis.contoso.com/products?api-version=v1` and `https://apis.contoso.com/products?api-version=v2` could refer to the same `products` API but to versions `v1` and `v2` respectively.
54
55
56
+
> [!NOTE]
57
+
> Query parameters aren't allowed in the `servers` propery of an OpenAPI specification. If you export an OpenAPI specification from an API version, a query string won't appear in the server URL.
58
+
55
59
## Original versions
56
60
57
61
If you add a version to a non-versioned API, an `Original` version will be automatically created and will respond on the default URL, without a version identifier specified. The `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` version isn't created.
@@ -68,6 +72,8 @@ A version set is automatically deleted when the final version is deleted.
68
72
69
73
You can view and manage version sets directly by using [Azure CLI](/cli/azure/apim/api/versionset), [Azure PowerShell](/powershell/module/az.apimanagement/#api-management), [Resource Manager templates](/azure/templates/microsoft.apimanagement/service/apiversionsets), or the [Azure Resource Manager API](/rest/api/apimanagement/current-ga/api-version-set).
70
74
75
+
> [!NOTE]
76
+
> All versions in a version set have the same versioning scheme, based on the versioning scheme used when you first add a version to an API.
71
77
### Migrating a non-versioned API to a versioned API
72
78
73
79
When you use the Azure portal to enable versioning on an existing API, the following changes are made to your API Management resources:
@@ -94,3 +100,5 @@ The details of an API also show a list of all of the versions of that API. An `O
94
100
95
101
> [!TIP]
96
102
> API versions need to be added to a product before they will be visible on the developer portal.
0 commit comments