DICOM hizmeti için API sürümü

Makale
04/27/2023

Bu başvuru kılavuzu, DICOM hizmeti için API sürüm ilkelerine genel bir bakış sağlar.

İsteklerde REST API sürümünü belirtme

REST API sürümü, aşağıdaki örnekte olduğu gibi istek URL'sinde açıkça belirtilmelidir:

<service_url>/v<version>/studies

Not

Sürümü olmayan yollar desteklenmez.

Desteklenen sürümler

Şu anda desteklenen sürümler şunlardır:

v1.0-ön sürüm
v1
v2

Desteklenen sürümler için OpenAPI Belgesi aşağıdaki URL'de bulunabilir:

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

DICOM Uyumluluk Bildirimi

DICOM API'lerinin tüm sürümleri her zaman DICOMweb™ Standart belirtimlerine uygun olacaktır, ancak farklı sürümler farklı API'leri kullanıma sunabilir. Ayrıntılar için uyumluluk bildiriminin belirli sürümüne bakın:

Yayın öncesi sürümler

"Ön sürüm" etiketine sahip bir API sürümü, sürümün üretim için hazır olmadığını ve yalnızca test ortamlarında kullanılması gerektiğini gösterir. Bu uç noktalar bildirimde bulunmadan hataya neden olan değişikliklerle karşılaşabilir.

Sürümler nasıl artırılır?

Şu anda yalnızca geriye dönük uyumlu olmadığı düşünülen bir hataya neden olan bir değişiklik olduğunda ana sürümü artırıyoruz.

Aşağıda hataya neden olan değişikliklere bazı örnekler verilmiştir (Ana sürüm artırılır):

Uç noktaları yeniden adlandırma veya kaldırma.
Parametreler kaldırılıyor veya zorunlu parametreler ekleniyor.
Durum kodu değiştiriliyor.
Yanıttaki bir özelliği silme veya yanıt türünü değiştirme, ancak yanıta özellik eklemenin bir sakıncası yok.
Özelliğin türünü değiştirme.
Api değiştiğinde davranış( örneğin iş mantığında yapılan değişiklikler gibi) ancak artık çıtayı aşıyor.

Hataya neden olmayan değişiklikler (Sürüm artımlı değildir):

Null değer atanabilen veya varsayılan değeri olan özelliklerin eklenmesi.
Yanıt modeline özellik ekleme.
Özelliklerin sırasını değiştirme.

Yanıt olarak üst bilgi

ReportApiVersions açık olduğundan, uygun olduğunda api-supported-versions ve api-deprecated-versions üst bilgilerini döndüreceğiz.

api-supported-versions, istenen API için desteklenen sürümleri listeler. Yalnızca ile ApiVersion("<someVersion>")ek açıklama eklenen bir uç nokta çağrılırken döndürülür.
api-deprecated-versions, istenen API için hangi sürümlerin kullanım dışı bırakıldığını listeler. Yalnızca ile ApiVersion("<someVersion>", Deprecated = true)ek açıklama eklenen bir uç nokta çağrılırken döndürülür.

Örnek:

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

Sonraki adımlar

Bu makalede, DICOM hizmeti için API sürüm ilkeleri hakkında bilgi edindi. DICOM hizmeti hakkında daha fazla bilgi için bkz.

DICOM hizmetine genel bakış

Aracılığıyla paylaş