Controllo delle versioni dell'API REST

  • Articolo

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

Usando le API REST con versione, è possibile assicurarsi che i progetti siano scalabili e gestibili nel tempo, mentre le applicazioni e i servizi continuano a funzionare man mano che le API si evolvono.

Linee guida

  • La versione dell'API deve essere specificata con ogni richiesta.
  • Le versioni api sono nel formato {major}. {minor} [-{stage}[.{ resource-version}]] - Ad esempio, 1.0, 1.1, 1.2-preview, 2.0.
  • Mentre un'API è in anteprima, è possibile specificare una versione precisa di una particolare revisione dell'API quando necessario (ad esempio, 1.0-preview.1, 1.0-preview.2).
  • Dopo il rilascio di un'API, 1.0, ad esempio, la relativa versione di anteprima (1.0-preview) viene deprecata e può essere disattivata dopo 12 settimane.
  • 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.

Utilizzo

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:

[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

Prodotto 1.0 2.0 3,0 4.0 5.0 6.0 7.0
Servizi di Azure DevOps 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 Team Foundation Server RTM. Ad esempio, il 3.0 set di API è stato introdotto con Team Foundation Server 2017.

Alcune API non documentate versione 1.0 esistono in Team Foundation Server 2013, ma non sono supportate.