API Versioning é a prática de gerenciar e acessar diferentes versões de uma API (Interface de Programação de Aplicações). É usada para evitar interrupções no serviço quando alterações significativas são feitas na API, como adicionar novos recursos ou modificar funcionalidades existentes.
Ao versionar uma API, os desenvolvedores podem introduzir novas funcionalidades ou melhorias sem afetar usuários que dependem da versão original. Isso é especialmente importante em ambientes de produção onde atualizar imediatamente para a última versão pode não ser viável.
Existem várias abordagens para versionamento de API, incluindo:
No URI (Uniform Resource Identifier): O número da versão é incluído na URL da API. Por exemplo, api.example.com/v1/resource.
No Header da Requisição: A versão é especificada nos cabeçalhos da requisição HTTP. Por exemplo, incluindo um cabeçalho Accept: application/vnd.example.v1+json.
Na Query String: A versão é passada como um parâmetro na string de consulta. Por exemplo, api.example.com/resource?version=1.
O versionamento de APIs ajuda a manter a compatibilidade com clientes antigos enquanto se introduz novas funcionalidades e melhorias.