Controle de versão da API para o serviço DICOM
Este guia de referência fornece uma visão geral das políticas de versão da API para o serviço DICOM.
Especificando a versão da API REST em solicitações
A versão da API REST deve ser especificada explicitamente na URL de solicitação, como no exemplo a seguir:
<service_url>/v<version>/studies
Observação
Não há suporte para rotas sem uma versão.
Versões com suporte
Atualmente, as versões com suporte são:
- v1.0-prerelease
- v1
- v2
O Documento do OpenAPI para as versões com suporte pode ser encontrado na seguinte URL:
<service_url>/v<version>/api.yaml
Instrução de conformidade DICOM
Todas as versões das APIs DICOM sempre estarão em conformidade com as especificações DICOMweb™ Standard, mas versões diferentes podem expor APIs diferentes. Consulte a versão específica da instrução de conformidade para obter detalhes:
Versões de pré-lançamento
Uma versão da API com o rótulo "pré-lançamento" indica que a versão não está pronta para produção e deve ser usada apenas em ambientes de teste. Esses pontos de extremidade podem sofrer alterações interruptivas sem aviso prévio.
Como as versões são incrementadas
Atualmente, incrementamos apenas a versão principal sempre que houver uma alteração interruptiva, que é considerada não compatível com versões anteriores.
Abaixo estão alguns exemplos de alterações interruptivas (a versão principal é incrementada):
- Renomeando ou removendo pontos de extremidade.
- Removendo parâmetros ou adicionando parâmetros obrigatórios.
- Alterando status código.
- Excluir uma propriedade em uma resposta ou alterar um tipo de resposta, mas não há problema em adicionar propriedades à resposta.
- Alterando o tipo de uma propriedade.
- Comportamento quando uma API é alterada, como alterações na lógica de negócios usadas para fazer foo, mas agora ela barra.
Alterações não interruptivas (a versão não é incrementada):
- Adição de propriedades que são anuláveis ou têm um valor padrão.
- Adição de propriedades a um modelo de resposta.
- Alterando a ordem das propriedades.
Cabeçalho em resposta
ReportApiVersions está ativado, o que significa que retornaremos os cabeçalhos api-supported-versions e api-deprecated-versions quando apropriado.
as versões compatíveis com a api listarão quais versões têm suporte para a API solicitada. Ele só é retornado ao chamar um ponto de extremidade anotado com
ApiVersion("<someVersion>").as versões preteridas da api listarão quais versões foram preteridas para a API solicitada. Ele só é retornado ao chamar um ponto de extremidade anotado com
ApiVersion("<someVersion>", Deprecated = true).
Exemplo:
[ApiVersion("1")]
[ApiVersion("1.0-prerelease", Deprecated = true)]
Próximas etapas
Neste artigo, você aprendeu sobre as políticas de versão da API para o serviço DICOM. Para obter mais informações sobre o serviço DICOM, consulte