Histórico da Página

...

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

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.

Segundo o guia de APIs, a versão é composta do seguinte formato:

"v" + majorVersion + "." + minorVersion

onde majorVersion e minorVersion são números inteiros sequenciais, sem "zeros" complementares.

Exemplos de APIs versionadas:

• /api/financeiro/v1/accountantAccounts
• /api/educacional/v1.5/disciplines
• /api/rh/v3.2/employees

As regras para versionamento das APIs, quando relacionadas a mensagem padronizada, são as seguintes:

• 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.