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

REST API-verziószámozás

  • Cikk

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 a projektek skálázhatóak és karbantarthatók legyenek az idő múlásával, az alkalmazások és szolgáltatások pedig az API-k fejlesztéseihez igazodva folyamatosan üzemeljenek.

Irányelvek

  • Az API-verziót minden kéréshez meg kell adni.
  • Az API-verziók formátuma {major}. {minor} [-{stage}[.{ resource-version}]] – Például, 1.0, 1.1, 1.2-preview2.0.
  • Amíg egy API előzetes verziójú, szükség esetén megadható az API egy bizonyos alverziójának pontos verziószáma (például: 1.0-preview.1, 1.0-preview.2).
  • Miután az API megjelent (például 1.0 verziószámmal), az előzetes verziója (1.0-preview) elavulttá válik, és 12 hét elteltével inaktiválható.
  • Ez idő alatt frissíteni kell az API megjelenéskori verziójára. Ha egy előzetes verziójú API inaktiválva lett, a kifejezetten a -preview verzióra vonatkozó kérések el lesznek utasítva.

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

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. Az API-készletet például a 3.0 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.