A DICOM-szolgáltatás API-verziókezelése
Ez a referencia-útmutató áttekintést nyújt a DICOM szolgáltatás API-verziószabályzatairól.
A REST API verziójának megadása a kérésekben
A REST API verzióját explicit módon meg kell adni a kérelem URL-címében, ahogy az alábbi példában látható:
<service_url>/v<version>/studies
Megjegyzés
A verzió nélküli útvonalak nem támogatottak.
Támogatott verziók
Jelenleg a támogatott verziók a következők:
- 1.0-prerelease
- v1
- v2
A támogatott verziók openAPI-dokumentuma a következő URL-címen található:
<service_url>/v<version>/api.yaml
DICOM megfelelőségi nyilatkozat
A DICOM API-k minden verziója mindig megfelel a DICOMweb™ Standard specifikációinak, de a különböző verziók különböző API-kat tehetnek közzé. A részletekért tekintse meg a megfelelőségi nyilatkozat adott verzióját:
Előzetes verziók
A "prerelease" címkével ellátott API-verzió azt jelzi, hogy a verzió nem áll készen az éles használatra, és csak tesztelési környezetekben szabad használni. Ezek a végpontok értesítés nélkül kompatibilitástörő változásokat tapasztalhatnak.
A verziók növekménye
Jelenleg csak akkor növeljük a főverziót, ha kompatibilitástörő változás történik, amely nem tekinthető visszamenőlegesen kompatibilisnek.
Az alábbiakban néhány példát láthat a kompatibilitástörő változásokra (a főverzió növekszik):
- Végpontok átnevezése vagy eltávolítása.
- Paraméterek eltávolítása vagy kötelező paraméterek hozzáadása.
- Állapotkód módosítása.
- Egy tulajdonság törlése egy válaszban vagy egy választípus módosítása, de nem baj, ha tulajdonságokat ad hozzá a válaszhoz.
- Tulajdonság típusának módosítása.
- Viselkedés, amikor egy API megváltozik, például az üzleti logikának a foo-hoz használt változásai, de most már sávot is használ.
Nem kompatibilitástörő változások (a verzió nem növekszik):
- Nullázható vagy alapértelmezett értékkel rendelkező tulajdonságok hozzáadása.
- Tulajdonságok hozzáadása válaszmodellhez.
- A tulajdonságok sorrendjének módosítása.
Fejléc a válaszban
A ReportApiVersions be van kapcsolva, ami azt jelenti, hogy adott esetben visszaadjuk az api-supported-versions és az api-deprecated-versions fejléceket.
Az api-supported-versions listázni fogja, hogy mely verziók támogatottak a kért API-hoz. Ez csak akkor lesz visszaadva, ha egy végpontot a () jellel
ApiVersion("<someVersion>")jegyzettel jelölve hív meg.Az api-deprecated-versions listázni fogja, hogy mely verziók lettek elavultak a kért API-hoz. Ez csak akkor lesz visszaadva, ha egy végpontot a () jellel
ApiVersion("<someVersion>", Deprecated = true)jegyzettel jelölve hív meg.
Példa:
[ApiVersion("1")]
[ApiVersion("1.0-prerelease", Deprecated = true)]
Következő lépések
Ebben a cikkben megismerkedett a DICOM szolgáltatás API-verziószabályzataival. A DICOM szolgáltatással kapcsolatos további információkért lásd: