Por que a estratégia de versionamento de API é importante

Azure API Management

Fiodar Sazanavets

Senior Software Engineer at Microsoft

Introdução ao versionamento de API

Introdução ao versionamento

Analogia de versionamento

Usado quando mudanças disruptivas confundiriam passageiros
Enquanto a nova linha é construída, passageiros usam a antiga
Revisões são como manutenção na mesma linha
- Ajustar trilhos, adicionar sinalização, suavizar a viagem
No APIM:
- Versões vivem em um conjunto de versões
- Revisões permitem editar, testar e marcar uma como atual

Três estratégias de indicação de versão são suportadas:
- A versão pode ser declarada no caminho da URL
- A versão pode ser informada no cabeçalho da requisição
- A versão pode ser informada na query string da URL
A estratégia de versionamento precisa ser consistente

Versionamento no caminho da URL

Versionamento por cabeçalho

Versionamento por query string

Versão vs. revisão

Canary release

Resultados:
- Se o feedback for bom -> marque a revisão como atual
- Se for ruim -> faça rollback para a revisão anterior

Como um teste de cozinha: sirva a nova receita a poucas mesas primeiro
No APIM:
- Crie uma nova revisão e teste em privado
- Exponha para um público limitado (produto piloto ou subconjunto de chamadores)
- Direcione uma revisão específica via URL especial com o número da revisão
Metáfora ferroviária: testadores usam a "via de manutenção" sem afetar a linha principal

API Management

Azure API Management