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.11.2-preview2.0

  • 当 API 处于预览状态时,可以根据需要指定 API 的特定修订版的精确版本。 例如:1.0-preview.11.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

支持的版本

注释

Azure DevOps Services REST API 参考中记录了所有支持的 Rest API。

Team Foundation Server 于 2019 年重命名为 Azure DevOps Server。

产品 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(团队基础服务器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,但不受支持。