À medida que as APIs evoluem para responder às exigências do mercado e tirar partido dos avanços tecnológicos, a gestão de versões torna-se essencial. As APIs abertas servem como canais cruciais para as equipas técnicas disponibilizarem serviços e dados externamente. No entanto, a evolução do negócio e o progresso tecnológico conduzem inevitavelmente a várias iterações de versões dos seus endpoints. Esta alteração é natural e necessária à medida que as equipas otimizam funcionalidades, introduzem novas funcionalidades e corrigem erros.Gerir várias versões de API é crucial para servir diferentes grupos de utilizadores, garantindo simultaneamente compatibilidade e inovação. Esta abordagem permite às equipas disponibilizar serviços estáveis e em evolução, mantendo o controlo de versões, minimizando perturbações para os utilizadores existentes e assegurando a continuidade e a fiabilidade do negócio.
As equipas podem precisar de disponibilizar várias versões de API em simultâneo — como a versão mais recente, a versão estável e versões de manutenção de longo prazo — para garantir uma perturbação mínima para os utilizadores em versões mais antigas.
Criação completa de versõesUma nova versão de API pode ser criada com base numa 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. Em alternativa, pode começar com uma versão de API em branco e adicionar endpoints manualmente.
Partilha abrangenteSelecione uma ou mais versões de API do seu projeto para publicar. Todos os endpoints nas versões selecionadas ficarão visíveis para os utilizadores. Ao publicar, o nome de apresentação e as definições de slug da versão de API podem ser configurados para melhorar a experiência do leitor.
Alternância com um cliqueSe tiverem sido publicadas várias versões de API, os utilizadores podem alternar entre elas através de um seletor de versões localizado junto ao nome do projeto na página pública. Ao clicar numa versão, serão apresentados todos os endpoints e conteúdos relacionados com essa versão específica.
Diferença entre "Versão da API" e "Ramo de Sprint"
Versão da API: Concebida para lançamento externo, especialmente quando alterações importantes causam incompatibilidades significativas entre versões. Contém todos os endpoints, não apenas os modificados ou recém-adicionados
Ramo de Sprint: Utilizado internamente pelas equipas de desenvolvimento, alinhado com o conceito de "sprint" no desenvolvimento ágil. Cada sprint cria normalmente um ramo que inclui apenas endpoints novos ou modificados, excluindo os que não foram alterados
