Przechowywanie wersji interfejsu API REST

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

Korzystając z wersjonowanych interfejsów API REST, możesz mieć pewność, że projekty są skalowalne i konserwowane wraz z upływem czasu, a aplikacje i usługi będą nadal działać w miarę rozwoju interfejsów API.

Wytyczne

• wersję API trzeba określić przy każdym żądaniu.

• Wersje interfejsu API mają format {major}.{minor}[-{stage}[.{resource-version}]]. Na przykład: 1.0, 1.1, 1.2-preview, 2.0

• Interfejs API jest w wersji zapoznawczej, można w razie potrzeby określić dokładną wersję określonej wersji interfejsu API. Na przykład: 1.0-preview.1, 1.0-preview.2

• Po wydaniu (1.0na przykład) interfejsu API jego wersja zapoznawcza (1.0-preview) jest przestarzała 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

Parametr zapytania identyfikatora 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

Nazwa serwera Team Foundation Server została zmieniona na Azure DevOps Server w 2019 roku.

Główne wersje interfejsu API są wydawane jednocześnie z wersjami RTM serwera Team Foundation Server. Na przykład zestaw interfejsu API 3.0 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.

Powiązana zawartość

• Wprowadzenie do interfejsów API REST
• Dokumentacja interfejsu API REST usługi Azure DevOps Services