Delen via


REST API-versiebeheer

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

Met behulp van REST API's met versiebeheer kunt u ervoor zorgen dat uw projecten in de loop van de tijd schaalbaar en onderhoudbaar zijn en dat uw toepassingen en services blijven werken naarmate API's zich ontwikkelen.

Richtsnoeren

  • API-versie moet worden opgegeven bij elke aanvraag.

  • API-versies hebben de indeling {major}.{minor}[-{stage}[.{resource-version}]]. Bijvoorbeeld: 1.0, 1.1, 1.2-preview, 2.0

  • Terwijl 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, 1.0-preview.2

  • Nadat een API is uitgebracht (1.0bijvoorbeeld), is de preview-versie (1.0-preview) afgeschaft en kan deze na 12 weken worden gedeactiveerd.

  • Gedurende deze tijd moet u een upgrade uitvoeren naar de uitgebrachte versie van de API. Zodra een preview-API is gedeactiveerd, worden aanvragen die een -preview versie opgeven geweigerd.

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-queryparameter:

[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

Notitie

Alle ondersteunde REST API's worden beschreven in de Naslaginformatie over de Rest API van Azure DevOps Services.

Team Foundation Server is in 2019 hernoemd naar Azure DevOps Server.

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

Belangrijke API-versieversies vallen samen met de RTM-releases van Team Foundation Server. De 3.0 API-set is bijvoorbeeld 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.