Megosztás a következőn keresztül:

REST API-verziószámozás

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

A verziószámozott REST API-k használatával gondoskodhat arról, hogy projektjei idővel skálázhatóak és karbantarthatók legyenek, miközben az alkalmazások és szolgáltatások folyamatosan működnek az API-k fejlődésével.

Iránymutatások

  • Az API-verziót meg kell adni minden kéréshez.
  • Az API-verziók formátuma {major}. {minor}[-{stage}[.{ resource-version}]] – Például 1.0, 1.1, 1.2-preview, 2.0.
  • Bár az API előzetes verzióban érhető el, szükség esetén megadhatja az API egy adott változatának pontos verzióját (például 1.0-preview.1, 1.0-preview.2).
  • Az API kiadása (például 1.0) után az előzetes verzió (1.0-preview) elavult, és 12 hét után inaktiválható.
  • Ez idő alatt frissítenie kell az API kiadott verziójára. Az előzetes verziójú API inaktiválása után a -preview verziót meghatározó kérések elutasításra kerülnek.

Használat

Az API-verzió megadható a HTTP-kérelem fejlécében vagy URL-lekérdezési paraméterként:

HTTP-kérelem fejléce:

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

Támogatott verziók

Jegyzet

Minden támogatott Rest API dokumentálva van az Azure DevOps REST API-referencia

Termék 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 X X X - - - -
Team Foundation Server 2015 X X - - - - -

A fő API-verziók a Team Foundation Server RTM-kiadásokhoz igazodnak. A 3.0 API-készletet például a Team Foundation Server 2017-ben vezettük be.

Néhány nem dokumentált 1.0-s verziójú API már létezik a Team Foundation Server 2013-ban, de nem támogatottak.