Partager via

Contrôle de version de l’API REST

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

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

Lignes directrices

  • La version de l’API doit être spécifiée avec chaque requête.

  • Les versions d’API sont au format {major}.{minor}[-{stage}[.{resource-version}]]. Par exemple : 1.0, 1.1, 1.2-preview, 2.0

  • Si 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 (1.0par exemple), sa préversion (1.0-preview) est déconseillée et peut être désactivée après 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 version -preview sont rejetées.

Utilisation

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

En-tête de requête HTTP :

Accept: application/json;api-version=1.0

Paramètre de requête d’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

Remarque

Toutes les API REST prises en charge sont documentées dans la référence de l’API REST Azure DevOps Services.

Team Foundation Server a été renommé Azure DevOps Server en 2019.

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, l’ensemble d’API 3.0 a été introduit avec Team Foundation Server 2017.

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

Contenu connexe