Поделиться через

Управление версиями REST API

  • Статья

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

С помощью интерфейсов REST API с управлением версиями можно обеспечить масштабируемость и поддержку проектов с течением времени, когда приложения и службы будут продолжать работать по мере развития API.

Рекомендации

  • Версия API должна быть указана с каждым запросом.
  • Версии API находятся в формате {major}. {minor} [-{stage}[.{ resource-version}]] — например, 1.0, 1.1, 1.2-preview. 2.0
  • Пока API находится в предварительной версии, при необходимости можно указать точную версию конкретной редакции API (например, 1.0-preview.1, 1.0-preview.2).
  • После выпуска API (например, 1.0) его предварительная версия (например, 1.0-preview) становится нерекомендуемой и может быть отключена через 12 недель.
  • В течение этого времени необходимо выполнить обновление до выпущенной версии API. После отключения предварительной версии API запросы, в которых указана версия -preview, будут отклонены.

Использование

Версию API можно указать в заголовке HTTP-запроса или в качестве параметра URL-запроса:

Заголовок 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

Поддерживаемые версии

Продукт 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 2022 X X X X X X X
Azure DevOps Server 2020 X X X X X X -
Сервер Azure DevOps 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 - - - -

Выпуски основных версий API соответствуют выпускам RTM Team Foundation Server. Например, 3.0 набор API был представлен с Team Foundation Server 2017.

В Team Foundation Server 2013 существовало несколько незадокументированных API версии 1.0, но не поддерживаются.