Pular para o conteúdo
AchaduDevelopers
API operacionalIr para o site
Painel
Achadu/Developers/Versionamento

Evolução compatível, migrações explícitas.

A versão principal fica na URL. Mudanças aditivas entram em v1 sem quebrar clientes; mudanças incompatíveis exigem uma nova versão e janela de migração.

O que pode mudar em v1

Novos endpoints

Operações e recursos adicionais podem ser publicados.

Novos campos opcionais

Clientes devem ignorar propriedades desconhecidas em respostas.

Novos eventos

Assinaturas com * podem receber tipos adicionados ao catálogo.

Novos valores

Enums abertos podem ganhar estados ou provedores documentados.

O que exige nova versão

Remover ou renomear

Endpoint, campo ou valor existente não desaparece silenciosamente.

Mudar significado

Semântica, unidade ou formato incompatível exige contrato novo.

Tornar obrigatório

Um campo opcional não passa a obrigatório dentro da mesma versão.

Alterar autenticação

Mudanças incompatíveis de autorização recebem migração própria.

Ciclo de depreciação

1
Anúncio

A mudança entra no histórico com substituição e impacto.

2
Migração

As duas formas convivem durante a janela informada.

3
Aviso em produção

Documentação e respostas identificam o contrato descontinuado.

4
Encerramento

A remoção acontece somente na data anunciada.

Como escrever um cliente resiliente

Ignore campos de resposta desconhecidos.
Trate enums desconhecidos como um estado válido não suportado.
Não dependa da ordem das propriedades JSON.
Use a versão da URL, não uma versão inferida do SDK.
Acompanhe o histórico antes de atualizar um cliente gerado.