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

Управление версиями 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

Ури:

[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

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

Заметка

Все поддерживаемые интерфейсы REST API описаны в справочном документе Azure DevOps по REST API

Продукт 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 (Тим Фаундейшн Сервер 2017) X X X - - - -
Team Foundation Server 2015 X X - - - - -

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

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