Freigeben über


REST-API-Versionsverwaltung

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

Mithilfe versionsgesteuerter REST-APIs können Sie sicherstellen, dass Ihre Projekte im Laufe der Zeit skalierbar und verwaltet werden können und dass Ihre Anwendungen und Dienste weiterhin funktionieren, während APIs weiterentwickelt werden.

Leitlinien

  • Die API-Version muss mit jeder Anforderung angegeben werden.

  • API-Versionen befinden sich im Format {major}.{minor}[-{stage}[.{resource-version}]]. Beispiel: 1.0, 1.1, 1.2-preview, 2.0

  • Während sich eine API in der Vorschau befindet, können Sie bei Bedarf eine genaue Version einer bestimmten Revision der API angeben. Beispiel: 1.0-preview.1, 1.0-preview.2

  • Nach der Veröffentlichung einer API (1.0z. B.) ist die Vorschauversion (1.0-preview) veraltet und kann nach 12 Wochen deaktiviert werden.

  • Während dieser Zeit sollten Sie ein Upgrade auf die veröffentlichte Version der API durchführen. Sobald eine Vorschau-API deaktiviert ist, werden Anforderungen, die eine Version vom Typ -preview angeben, abgelehnt.

Verwendung

Die API-Version kann entweder im Header der HTTP-Anforderung oder als URL-Abfrageparameter angegeben werden:

HTTP-Anforderungsheader:

Accept: application/json;api-version=1.0

URI-Abfrageparameter:

[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

Unterstützte Versionen

Hinweis

Alle unterstützten Rest-APIs sind in der REST-API-Referenz für Azure DevOps Services dokumentiert.

Team Foundation Server wurde 2019 in Azure DevOps Server umbenannt.

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

Hauptversionsversionen der API stimmen mit Team Foundation Server RTM-Releases überein. Beispielsweise wurde der 3.0 API-Satz mit Team Foundation Server 2017 eingeführt.

Einige nicht dokumentierte Version 1.0-APIs sind in Team Foundation Server 2013 vorhanden, werden jedoch nicht unterstützt.