다음을 통해 공유


REST API 버전 관리

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

버전이 지정된 REST API를 사용하면 시간이 지남에 따라 프로젝트를 확장 가능하고 유지 관리할 수 있으며 API가 진화함에 따라 애플리케이션과 서비스가 계속 작동하도록 할 수 있습니다.

지침

  • API 버전 모든 요청에 지정해야 합니다.

  • API 버전은 형식 {major}.{minor}[-{stage}[.{resource-version}]]입니다. 예: 1.0, 1.1, 1.2-preview2.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

지원되는 버전

메모

지원되는 모든 Rest API는 Azure DevOps Services REST API 참조에 설명되어 있습니다.

Team Foundation Server는 2019년에 Azure DevOps Server로 이름이 바뀌었습니다.

제품 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 - - -
팀 파운데이션 서버 2017 X X X - - - -
팀 파운데이션 서버 2015 X X - - - - -

주요 API 버전 릴리스는 Team Foundation Server RTM 릴리스와 일치합니다. 예를 들어 3.0 API 집합은 Team Foundation Server 2017에서 도입되었습니다.

문서화되지 않은 몇 가지 버전 1.0 API는 Team Foundation Server 2013에 있었지만 지원되지 않습니다.