Sdílet prostřednictvím

Správa verzí rozhraní REST API

  • Článek

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

Pomocí rozhraní REST API se správou verzí můžete zajistit, aby vaše projekty byly škálovatelné a průběžně udržovatelné, zatímco aplikace a služby budou dál fungovat v průběhu vývoje rozhraní API.

Pokyny

  • U každého požadavku musí být zadána verze rozhraní API.
  • Verze rozhraní API jsou ve formátu {major}. {minor} [-{stage}[.{ resource-version}]] – například 1.0, 1.1, 1.2-preview, 2.0.
  • Zatímco je rozhraní API ve verzi Preview, můžete v případě potřeby zadat přesnou verzi konkrétní revize rozhraní API (například 1.0-preview.1, 1.0-preview.2).
  • Po vydání rozhraní API (například 1.0) je jeho verze Preview (1.0-preview) zastaralá a po 12 týdnech se dá deaktivovat.
  • Během této doby byste měli upgradovat na vydanou verzi rozhraní API. Po deaktivaci rozhraní API verze Preview se požadavky, které určují verzi -preview, zamítnou.

Využití

Verzi rozhraní API je možné zadat buď v hlavičce požadavku HTTP, nebo jako parametr dotazu adresy URL:

Hlavička požadavku 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

Podporované verze

Produkt 1.0 2.0 3,0 4.0 5,0 6.0 7.0
Služby Azure DevOps 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 - - - -

Hlavní verze verzí rozhraní API jsou v souladu s verzemi RTM pro Team Foundation Server. Sada rozhraní API byla například 3.0 představena v sadě Team Foundation Server 2017.

V Team Foundation Serveru 2013 existovalo několik nezdokumentovaných rozhraní API verze 1.0, ale nepodporuje se.