Estratégias de Versionamento de API

Estratégias de versionamento de API garantem evolução suave de APIs enquanto mantêm compatibilidade. GitScrum ajuda equipes a rastrear mudanças de API, decisões de versionamento e migração de cliente através de ciclos de desenvolvimento.

Ciclo de vida de versionamento de API

Design API ──► Implementar v1 ──► Planejar Mudanças ──► Lançar v2 ──► Descontinuar v1 ──► Remover v1
     │              │              │              │              │              │
     ▼              ▼              ▼              ▼              ▼              ▼
  Requisitos       Primeiro Lançamento  Análise de Mudanças  Compatível      Período de Sunset  Comunicação
  Coletados        & Documentação       Quebradoras          Retroativas     & Suporte de      de Fim de Vida
                                                  Atualizações               Migração

Estratégias de versionamento

• Versionamento URI: /api/v1/users, /api/v2/users - claro e explícito
• Versionamento de cabeçalho: Accept: application/vnd.api.v1+json - negociação de conteúdo
• Parâmetro de consulta: /api/users?version=1 - flexível mas menos RESTful
• Tipo de mídia: application/vnd.company.resource.v2+json - versionamento semântico

Melhores práticas de evolução de API

Mudanças Quebradoras ──► Nova Versão ──► Descontinuação ──► Migração ──► Remoção
        │                  │              │              │            │
        ▼                  ▼              ▼              ▼            ▼
  Análise de Impacto     Versionamento Semântico  Cabeçalhos de Aviso  Atualizações de Cliente  Fim de Suporte
  & Comunicação                       & Documentação

Soluções Relacionadas

• Melhores práticas de design de API
• Melhores práticas de desenvolvimento de API
• Desenvolvimento API first