Bagikan melalui

Penerapan versi REST API

  • Artikel

Layanan Azure DevOps | Azure DevOps Server 2022 - Azure DevOps Server 2019

Dengan menggunakan penerapan versi REST API, Anda dapat memastikan proyek Anda dapat diskalakan dan dapat dipertahankan dari waktu ke waktu sementara aplikasi dan layanan terus berfungsi seiring berkembangnya API.

Panduan

  • Versi API harus ditentukan dengan setiap permintaan.
  • Versi API dalam format {major}. {minor} [-{stage}[.{ resource-version}]] - Misalnya, , 1.0, 1.1, 1.2-preview2.0.
  • Saat API dalam pratinjau, Anda dapat menentukan versi yang tepat dari revisi API tertentu saat diperlukan (misalnya, 1.0-preview.1, 1.0-preview.2).
  • Setelah API dirilis (1.0, misalnya), versi pratinjaunya (pratinjau 1.0) tidak digunakan lagi dan dapat dinonaktifkan setelah 12 minggu.
  • Selama waktu ini, Anda harus meningkatkan ke versi API yang dirilis. Setelah API pratinjau dinonaktifkan, permintaan yang menentukan versi -preview ditolak.

Penggunaan

Versi API dapat ditentukan baik di header permintaan HTTP atau sebagai parameter kueri URL:

Header permintaan 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

Versi yang didukung

Produk 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 - - - -

Rilis versi API utama selaras dengan rilis RTM Team Foundation Server. Misalnya, 3.0 set API diperkenalkan dengan Team Foundation Server 2017.

Beberapa API versi 1.0 yang tidak terdokumentasi ada di Team Foundation Server 2013, tetapi tidak didukung.