REST API のバージョン管理
Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019
バージョン管理された REST API を使用すると、アプリケーションとサービスが API の進化に合わせて引き続き機能する一方で、プロジェクトが時間の経過と共にスケーラブルで保守可能であることを確認できます。
ガイドライン
- API バージョンは、すべての要求で指定 する必要があります 。
- API バージョンは {major} の形式です。{minor}[-{stage}[.{resource-version}]] - たとえば、、
1.1、1.01.2-preview、2.0です。 - API がプレビュー段階にある間は、必要に応じて API の特定のリビジョンの正確なバージョンを指定できます (例: 、
1.0-preview.11.0-preview.2)。 - たとえば、API の 1.0 がリリースされた後、そのプレビュー バージョン (1.0-プレビュー) は非推奨となり、12 週間後に非アクティブ化できます。
- この期間中に、リリースされたバージョンの API にアップグレードする必要があります。 プレビュー API が非アクティブ化されると、バージョンを指定
-previewする要求は拒否されます。
使用法
API のバージョンは、HTTP 要求の ヘッダーで指定することも、URL クエリ パラメーターとして指定することもできます。
HTTP 要求ヘッダー:
Accept: application/json;api-version=1.0
URI:
[scheme"://"][host[':'port]]"/v" major-version '/'namespace '/'resource ('/'resource)* '?' query
i.e. GET https://dev.azure.com/v1.0/{organization}/_apis/{area}/{resource}?some-query=1000
サポートされているバージョン
| 製品 | 1.0 | 2.0 | 3.0 | 4.0 | 5.0 | 6.0 | 7.0 |
|---|---|---|---|---|---|---|---|
| Azure DevOps Services | X | X | X | X | X | X | x |
| Azure DevOps Server 2022 | x | X | X | X | X | X | x |
| Azure DevOps Server 2020 | x | X | X | X | X | x | - |
| Azure DevOps Server 2019 | x | X | X | X | x | - | |
| Team Foundation Server 2018 | X | X | X | x | - | - | |
| Team Foundation Server 2017 | x | X | x | - | - | - | |
| Team Foundation Server 2015 | X | x | - | - | - | - |
メジャー API バージョンのリリースは、Team Foundation Server RTM リリースと一致します。 たとえば、 3.0 API セットは Team Foundation Server 2017 で導入されました。
ドキュメントに記載されていないバージョン 1.0 API がいくつか Team Foundation Server 2013 に存在しましたが、サポートされていません。