Partage via

Gestion des versions d’API

  • Article

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

À l’aide des API REST avec version, vous pouvez vous assurer que vos projets sont évolutifs et gérables au fil du temps, tandis que les applications et les services continuent de fonctionner à mesure que les API évoluent.

Consignes

  • La version de l’API doit être spécifiée avec chaque requête.
  • Les versions de l’API sont au format {major}. {minor} [-{stage}[.{ resource-version}]] - Par exemple, 1.0, 1.1, 1.2-preview, 2.0.
  • Lorsqu’une API est en préversion, vous pouvez spécifier une version précise d’une révision particulière de l’API si nécessaire (par exemple, 1.0-preview.1, 1.0-preview.2).
  • Une fois qu’une API est publiée, la version 1.0, par exemple, sa préversion (1.0-preview) est déconseillée et peut être désactivée au bout de 12 semaines.
  • Pendant ce temps, vous devez effectuer une mise à niveau vers la version publiée de l’API. Une fois qu’une API en préversion est désactivée, les demandes qui spécifient une -preview version sont rejetées.

Utilisation

La version de l’API peut être spécifiée soit dans l’en-tête de la requête HTTP, soit en tant que paramètre de requête d’URL :

En-tête de requête 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

Versions prises en charge

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

Les versions principales de l’API s’alignent sur les versions rtm de Team Foundation Server. Par exemple, le jeu d’API 3.0 a été introduit avec Team Foundation Server 2017.

Quelques API de version 1.0 non documentées existaient dans Team Foundation Server 2013, mais ne sont pas prises en charge.