Delen via

REST API-versiebeheer

  • Artikel

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

Door REST API's met versiebeheer te gebruiken, kunt u ervoor zorgen dat uw projecten in de loop van de tijd schaalbaar en onderhoudbaar zijn en dat toepassingen en services blijven werken als API's zich ontwikkelen.

Richtlijnen

  • API-versie moet worden opgegeven bij elke aanvraag.
  • API-versies hebben de indeling {major}. {minor} [-{stage}[.{ resource-version}]] - bijvoorbeeld , 1.01.1, 1.2-preview. 2.0
  • Als een API in preview is, kunt u een exacte versie van een bepaalde revisie van de API opgeven wanneer dat nodig is (bijvoorbeeld 1.0-preview.1 of 1.0-preview.2).
  • Nadat een API is uitgebracht, bijvoorbeeld 1.0, wordt de preview-versie (1.0-preview) afgeschaft en kan deze na 12 weken worden gedeactiveerd.
  • In deze periode moet u een upgrade uitvoeren naar de uitgebrachte versie van de API. Zodra een preview-API is gedeactiveerd, worden aanvragen geweigerd waarin een-preview-versie is opgegeven.

Gebruik

De API-versie kan worden opgegeven in de header van de HTTP-aanvraag of als url-queryparameter:

HTTP-aanvraagheader:

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

Ondersteunde versies

Product 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 - - - -

Primaire API-versiereleases zijn afgestemd op DE RTM-releases van Team Foundation Server. De API-set is bijvoorbeeld 3.0 geïntroduceerd met Team Foundation Server 2017.

Er bestaan enkele niet-gedocumenteerde versie 1.0 API's in Team Foundation Server 2013, maar worden niet ondersteund.