Share via

REST API 版本控制

  • 项目

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

使用已进行版本控制的 REST API，可以确保项目随着时间的推移是可缩放和可维护的，同时应用程序和服务可以随着 API 的发展而继续工作。

指导

  • 必须为每个请求指定 API 版本。
  • API 版本采用 {major} 格式。{minor}[-{stage}[.{resource-version}]] - 例如 、1.01.1、1.2-preview、2.0。
  • 当 API 处于预览状态时，可以根据需要指定 API 的特定修订版本的精确版本， (例如 、 1.0-preview.11.0-preview.2) 。
  • (1.0（例如) ）发布 API 后，其预览版本 (1.0 预览版) 已弃用，可在 12 周后停用。
  • 在此期间，应升级到 API 的已发布版本。 停用预览 API 后，将拒绝指定 -preview 版本的请求。

使用情况

可以在 HTTP 请求的标头中指定 API 版本，也可以指定为 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
2022 Azure DevOps Server 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，但不受支持。