REST API-versionshantering

  • Artikel

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

Genom att använda REST-API:er med versionshantering kan du se till att dina projekt är skalbara och underhållsbara över tid, samtidigt som program och tjänster fortsätter att fungera allt eftersom API:erna utvecklas.

Riktlinjer

  • API-versionen måste anges för varje begäran.
  • API-versioner är i formatet {major}. {minor} [-{stage}[.{ resource-version}]] – till exempel 1.0, 1.1, 1.2-preview, . 2.0
  • När ett API är i en förhandsversion kan du ange en exakt version av en viss revision av API:et när det behövs (till exempel 1.0-preview.1, 1.0-preview.2).
  • När ett API har släppts (till exempel 1.0), blir dess förhandsversion (1.0-förhandsversion) inaktuell och kan inaktiveras efter 12 veckor.
  • Under den här tiden bör du uppgradera till den utgivna versionen av API:et. När ett förhandsversions-API har inaktiverats, avvisas begäranden som anger en -preview-version.

Användning

API-versionen kan anges antingen i huvudet på HTTP-begäran eller som en URL-frågeparameter:

HTTP-begärandehuvud:

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

Versioner som stöds

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

Större VERSIONER av API-versioner överensstämmer med Team Foundation Server RTM-versioner. API-uppsättningen introducerades till exempel 3.0 med Team Foundation Server 2017.

Några odokumenterade VERSION 1.0-API:er fanns i Team Foundation Server 2013, men stöds inte.