Pular para o conteúdo principal

Versões e descontinuação

A versão vai no caminho: https://api.rmfestrategia.com/v1/....

O que não muda a versão​

Mudança aditiva continua em /v1: campo novo na resposta e operação nova. Escreva seu cliente para ignorar campos que não conhece e tratar codigo desconhecido como falha genérica do mesmo status HTTP.

O que muda a versão​

Remover ou renomear campo, mudar o tipo ou o significado de um campo, ou mudar uma regra de forma incompatível só acontece numa versão nova (/v2).

Descontinuação​

Operação ou versão que vai sair é avisada com cabeçalhos nas respostas:

CabeçalhoO que diz
Deprecation (RFC 9745)A operação está descontinuada
Sunset (RFC 8594)A data em que ela deixa de responder

Entre um e outro, pelo menos 6 meses. Registre esses cabeçalhos no seu monitoramento. As mudanças relevantes também ficam no changelog.