DICOM 服務的 API 版本設定

此參考指南提供 DICOM 服務的 API 版本原則概觀。

在要求中指定 REST API 的版本

REST API 的版本必須在要求 URL 中明確指定，如下列範例所示：

<service_url>/v<version>/studies

注意

不支援沒有版本的路由。

支援的版本

目前支援的版本如下：

• v1.0-prerelease
• v1
• v2

支援版本的 OpenAPI 檔位於下列 URL：

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

DICOM 一致性語句

所有版本的 DICOM API 一律會符合 DICOMweb™ Standard 規格，但不同版本可能會公開不同的 API。 如需詳細資訊，請參閱特定版本的一致性語句：

• DICOM 一致性語句 v1
• DICOM 一致性語句 v2

發行前版本

具有「發行前版本」標籤的 API 版本表示版本尚未準備好用於生產環境，而且應該只在測試環境中使用。 這些端點可能會發生中斷性變更，而不需注意。

如何遞增版本

我們目前只會在發生重大變更時遞增主要版本，這被視為與回溯不相容。

以下是主要版本遞增 (重大變更的一些範例，) ：

• 重新命名或移除端點。
• 移除參數或新增強制參數。
• 變更狀態碼。
• 刪除回應中的屬性，或完全改變回應類型，但您可以將屬性新增至回應。
• 變更屬性的類型。
• API 變更時的行為，例如商務邏輯中用來執行 foo 的變更，但現在會執行列。

(版本的非中斷性變更不會遞增) ：

• 新增可為 Null 或具有預設值的屬性。
• 將屬性新增至回應模型。
• 變更屬性的順序。

回應中的標頭

ReportApiVersions 已開啟，這表示我們會在適當情況下傳回標頭 api 支援的版本和 api-deprecated-versions。

• api 支援的版本會列出所要求 API 支援的版本。 只有在呼叫以 ApiVersion("<someVersion>") 標注的端點時，才會傳回它。

• api-deprecated-versions 會列出已針對要求 API 淘汰的版本。 只有在呼叫以 ApiVersion("<someVersion>", Deprecated = true) 標注的端點時，才會傳回它。

範例：

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

下一步

在本文中，您已瞭解 DICOM 服務的 API 版本原則。 如需 DICOM 服務的詳細資訊，請參閱

DICOM 服務概觀