共用方式為


REST API 版本設定

Azure DevOps 服務 |Azure DevOps Server |Azure DevOps Server 2022

使用已建立版本的 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

支援的版本

備註

所有支援的 Rest API 都會記載於 Azure DevOps Services 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,但不受支援。