Udostępnij za pośrednictwem

Przechowywanie wersji interfejsu API REST

  • Artykuł

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

Korzystając z wersjonowanych interfejsów API REST, możesz zapewnić skalowalność i możliwość utrzymywania projektów w czasie, ponieważ aplikacje i usługi będą nadal działać w miarę rozwoju interfejsów API.

Wytyczne

  • Wersja interfejsu API musi być określona przy każdym żądaniu.
  • Wersje interfejsu API mają format {major}. {pomocnicza} [-{stage}[.{ resource-version}]] — na przykład , 1.0, 1.11.2-preview, . 2.0
  • Kiedy interfejs API jest w wersji zapoznawczej, w razie potrzeby możesz określić dokładną wersję określonej poprawki interfejsu API (na przykład 1.0-preview.1, 1.0-preview.2).
  • Po wydaniu interfejsu API (np. w wersji 1.0) jego wersja zapoznawcza (1.0-preview) jest wycofywana i może zostać zdezaktywowana po upływie 12 tygodni.
  • W tym czasie należy przeprowadzić uaktualnienie do wydanej wersji interfejsu API. Po dezaktywacji interfejsu API w wersji zapoznawczej żądania określające wersję -preview będą odrzucane.

Użycie

Wersję interfejsu API można określić w nagłówku żądania HTTP lub jako parametr zapytania adresu URL:

Nagłówek żądania HTTP:

Accept: application/json;api-version=1.0

Identyfikator 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

Obsługiwane wersje

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

Główne wersje interfejsu API są zgodne z wersjami serwera Team Foundation Server RTM. Na przykład zestaw interfejsów 3.0 API został wprowadzony w programie Team Foundation Server 2017.

W programie Team Foundation Server 2013 istniało kilka nieudokumentowanych interfejsów API w wersji 1.0, ale nie są obsługiwane.