REST API 版本控制
Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019
透過已建立版本的 REST API,您可隨時確保可調整和維護您的專案,而應用程式和服務會在 API 演進時持續運作。
指導方針
- 每個要求都必須指定 API 版本。
- API 版本的格式為 {major}。{minor}[-{stage}[.{resource-version}]] - 例如、
1.0
、1.1
1.2-preview
、2.0
。 - 當 API 為預覽時,您可視需要指定特定 API 修訂的精確版本 (例如
1.0-preview.1
、1.0-preview.2
)。 - 在發行 API 後 (以 1.0 為例),其預覽版本 (1.0-preview) 將被取代並可在 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
支援的版本
Products | 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 引進的。
Team Foundation Server 2013 中存在一些未記載的版本 1.0 API,但不受支援。