REST-API-Versionsverwaltung

  • Artikel

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

Durch die Verwendung von versionierten REST-APIs können Sie sicherstellen, dass Ihre Projekte langfristig skalierbar und wartbar sind, während Anwendungen und Dienste weiterhin funktionieren, wenn sich die APIs weiterentwickeln.

Richtlinien

  • Die API-Version muss bei jeder Anforderung angegeben werden.
  • API-Versionen haben das 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 (z. B 1.0-preview.1. , 1.0-preview.2).
  • Sobald eine API veröffentlicht wurde (z. B. 1.0), 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 -preview Version 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:

[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

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 waren in Team Foundation Server 2013 vorhanden, werden aber nicht unterstützt.