À medida que as APIs evoluem para atender às demandas do mercado e aproveitar os avanços tecnológicos, o gerenciamento de versões torna-se essencial. APIs abertas servem como canais cruciais para que equipes técnicas entreguem serviços e dados externamente. No entanto, a evolução dos negócios e o progresso tecnológico inevitavelmente levam a múltiplas iterações de versão dos seus endpoints. Essa mudança é natural e necessária à medida que as equipes otimizam funcionalidades, introduzem novos recursos e corrigem bugs.Gerenciar múltiplas versões de API é crucial para atender a diferentes grupos de usuários, garantindo compatibilidade e inovação. Essa abordagem permite que as equipes entreguem serviços estáveis e em evolução, mantendo o controle de versões, minimizando interrupções para usuários existentes e garantindo continuidade e confiabilidade dos negócios.
As equipes podem precisar oferecer múltiplas versões de API simultaneamente — como as versões mais recente, estável e de manutenção de longo prazo — para garantir interrupção mínima para usuários em versões mais antigas.
Criação completa de versãoUma nova versão de API pode ser criada com base em uma versão de API existente, contendo cópias de todos os endpoints da versão original. Após a criação, cada endpoint dentro da versão pode ser modificado conforme necessário. Como alternativa, você pode começar a partir de uma versão de API em branco e adicionar endpoints manualmente.
Compartilhamento abrangenteSelecione uma ou mais versões de API do seu projeto para publicar. Todos os endpoints dentro das versões selecionadas ficarão visíveis para os usuários. Ao publicar, o nome de exibição e as configurações de slug da versão de API podem ser configurados para aprimorar a experiência do leitor.
Alternância com um cliqueSe múltiplas versões de API tiverem sido publicadas, os usuários poderão alternar entre elas por meio de um seletor de versão localizado ao lado do nome do projeto na página pública. Clicar em uma versão exibirá todos os endpoints e conteúdos relacionados a essa versão específica.
Diferença entre "Versão de API" e "Branch de Sprint"
Versão de API: Projetada para lançamento externo, especialmente quando mudanças importantes causam incompatibilidades significativas entre versões. Contém todos os endpoints, não apenas os modificados ou recém-adicionados
Branch de Sprint: Usada internamente por equipes de desenvolvimento, alinhada ao conceito de "sprint" no desenvolvimento ágil. Cada sprint normalmente cria uma branch incluindo apenas endpoints novos ou modificados, excluindo os que não foram alterados
