Condividi tramite


Controllo delle versioni dell'API REST

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

Using versioned REST APIs, you can ensure that your projects are scalable and maintainable over time, and that your applications and services continue to work as APIs evolve.

Istruzioni

  • La versione api deve essere specificata con ogni richiesta.

  • API versions are in the format {major}.{minor}[-{stage}[.{resource-version}]]. Ad esempio: 1.0, 1.1, 1.2-preview, 2.0

  • While an API is in preview, you can specify a precise version of a particular revision of the API when needed. For example: 1.0-preview.1, 1.0-preview.2

  • After an API is released (1.0, for example), its preview version (1.0-preview) is deprecated and can be deactivated after 12 weeks.

  • Durante questo periodo, è necessario eseguire l'aggiornamento alla versione rilasciata dell'API. Dopo la disattivazione di un'API di anteprima, le richieste che specificano una versione -preview vengono rifiutate.

Uso

La versione dell'API può essere specificata nell'intestazione della richiesta HTTP o come parametro di query URL:

Intestazione della richiesta HTTP:

Accept: application/json;api-version=1.0

Uri query parameter:

[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

Versioni supportate

Nota

All supported Rest APIs are documented in the Azure DevOps Services REST API Reference.

Team Foundation Server was renamed Azure DevOps Server in 2019.

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

Le versioni principali dell'API sono allineate alle versioni RTM di Team Foundation Server. Ad esempio, il set di API 3.0 è stato introdotto con Team Foundation Server 2017.

Esistono alcune API non documentate versione 1.0 in Team Foundation Server 2013, ma non sono supportate.