Управление версиями API для службы DICOM

  • Статья

В этом справочном руководстве представлен обзор политик версий API для службы DICOM.

Указание версии REST API в запросах

Версия REST API должна быть явно указана в URL-адресе запроса, как показано в следующем примере:

<service_url>/v<version>/studies

Примечание

Маршруты без версии не поддерживаются.

Поддерживаемые версии

В настоящее время поддерживаются следующие версии:

  • Предварительная версия 1.0
  • Версия 1
  • Версия 2

Документ OpenAPI для поддерживаемых версий можно найти по следующему URL-адресу:

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

Заявление о соответствии DICOM

Все версии API DICOM всегда будут соответствовать спецификациям DICOMweb™ Standard, но разные версии могут предоставлять разные API. Дополнительные сведения см. в конкретной версии оператора соответствия:

Предварительные версии

Версия API с меткой "предварительная версия" указывает, что версия не готова к использованию в рабочей среде и должна использоваться только в средах тестирования. Эти конечные точки могут испытывать критические изменения без уведомления.

Как увеличиваются версии

В настоящее время основная версия увеличивается только при критическом изменении, которое считается несовместимым с обратной совместимостью.

Ниже приведены некоторые примеры критических изменений (основная версия увеличивается):

  • Переименование или удаление конечных точек.
  • Удаление параметров или добавление обязательных параметров.
  • Изменение кода состояния.
  • Удаление свойства в ответе или изменение типа ответа вообще, но можно добавить свойства в ответ.
  • Изменение типа свойства.
  • Поведение при изменениях API, например изменения в бизнес-логике, используемой для выполнения foo, но теперь он делает бар.

Некриминационные изменения (версия не увеличивается):

  • Добавление свойств, допускающих значение NULL или имеющих значение по умолчанию.
  • Добавление свойств в модель ответа.
  • Изменение порядка свойств.

Заголовок в ответе

ReportApiVersions включен. Это означает, что при необходимости мы возвращаем заголовки api-supported-versions и api-deprecated-versions.

  • Api-supported-versions содержит список версий, поддерживаемых для запрошенного API. Он возвращается только при вызове конечной точки с ApiVersion("<someVersion>")заметками .

  • api-deprecated-versions выводит список версий, которые были нерекомендуемыми для запрошенного API. Он возвращается только при вызове конечной точки с ApiVersion("<someVersion>", Deprecated = true)заметками .

Пример

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

Снимок экрана: поддерживаемые и устаревшие версии API.

Дальнейшие действия

Из этой статьи вы узнали о политиках версий API для службы DICOM. Дополнительные сведения о службе DICOM см. в разделе

Обзор службы DICOM