Histórico da Página

...

 Clique aqui para retornar ao Fluxograma de Criação de Integrações

3.5 Versionamento da API

O versionamento de APIs que atuam sobre entidades com mensagem padronizada seguirá o padrão definido pelo guia de APIs, sendo independente da versão da mensagem padronizada. Entretanto, mudanças no modelo de dados implicam em mudança no contrato da API e, consequentemente, podem exigir alteração da versão da API.

...

• Alterando-se a minorVersion da mensagem padronizada, deve-se alterar a minorVersion da API.
• Alterando-se a majorVersion da mensagem padronizada, deve-se alterar a majorVersion da API.
• Inclusão de verbos HTTP, ações ou filtros na API não alteram versão.
• Alteração de comportamento de endpoint ou na forma de passar os parâmetros alteram versão da API, entretanto não é necessário replicar todos os outros endpoints da API para a nova versão.

3.5.1 Exemplos de versionamento

Para tornar mais claro como versionar as APIs baseadas em mensagem padronizada, colocaremos a seguir um caso de uso.

...