Bagikan melalui

Pembuatan versi API untuk layanan DICOM

  • Artikel

Panduan referensi ini memberi Anda gambaran umum tentang kebijakan versi API untuk layanan DICOM.

Menentukan versi REST API dalam permintaan

Versi REST API harus ditentukan secara eksplisit dalam URL permintaan seperti dalam contoh berikut:

<service_url>/v<version>/studies

Catatan

Rute tanpa versi tidak didukung.

Versi yang didukung

Saat ini versi yang didukung adalah:

  • v1.0-prarilis
  • v1
  • v2

Dokumen OpenAPI untuk versi yang didukung dapat ditemukan di url berikut:

<service_url>/v<version>/api.yaml

Pernyataan Kesuaian DICOM

Semua versi API DICOM akan selalu sesuai dengan spesifikasi DICOMweb™ Standard, tetapi versi yang berbeda dapat mengekspos API yang berbeda. Lihat versi spesifik pernyataan kesuaian untuk detailnya:

Versi prarilis

Versi API dengan label "prarilis" menunjukkan bahwa versi belum siap untuk produksi, dan hanya boleh digunakan dalam lingkungan pengujian. Titik akhir ini mungkin mengalami perubahan yang melanggar tanpa pemberitahuan.

Bagaimana versi dinaikkan

Saat ini kami hanya meningkatkan versi utama setiap kali ada perubahan yang melanggar, yang dianggap tidak kompatibel mundur.

Di bawah ini adalah beberapa contoh perubahan mencolok (Versi utama dinaikkan):

  • Mengganti nama atau menghapus titik akhir.
  • Menghapus parameter atau menambahkan parameter wajib.
  • Mengubah kode status.
  • Menghapus properti dalam respons, atau mengubah jenis respons sama sekali, tetapi tidak apa-apa untuk menambahkan properti ke respons.
  • Mengubah jenis properti.
  • Perilaku ketika API berubah seperti perubahan logika bisnis yang digunakan untuk melakukan foo, tetapi sekarang melakukan bar.

Perubahan yang tidak melanggar (Versi tidak dinaikkan):

  • Penambahan properti yang dapat diubah ke null atau memiliki nilai default.
  • Penambahan properti ke model respons.
  • Mengubah urutan properti.

Header sebagai respons

ReportApiVersions diaktifkan, yang berarti kami akan mengembalikan header api-supported-versions dan api-deprecated-versions jika sesuai.

  • versi yang didukung api akan mencantumkan versi mana yang didukung untuk API yang diminta. Ini hanya dikembalikan saat memanggil titik akhir yang diannotasikan dengan ApiVersion("<someVersion>").

  • api-deprecated-versions akan mencantumkan versi mana yang tidak digunakan lagi untuk API yang diminta. Ini hanya dikembalikan saat memanggil titik akhir yang diannotasikan dengan ApiVersion("<someVersion>", Deprecated = true).

Contoh:

[ApiVersion("1")]
[ApiVersion("1.0-prerelease", Deprecated = true)]

Cuplikan layar API yang didukung dan versi yang tidak digunakan lagi.

Langkah berikutnya

Dalam artikel ini, Anda mempelajari tentang kebijakan versi API untuk layanan DICOM. Untuk informasi selengkapnya tentang layanan DICOM, lihat

Gambaran umum layanan DICOM