Versionamento
https://api.astroway.info/v1/chartSemVer para a API
Seção intitulada “SemVer para a API”Seguimos a semântica do semver.org:
- MAJOR (
v1→v2): breaking changes. A versão antiga continua a funcionar pelo menos 12 meses após o lançamento da nova. - MINOR: novos endpoints, novos campos opcionais. Totalmente compatível.
- PATCH: correções de bugs, refinamentos de precisão. Visível através do header
X-Api-Version: 1.12.3na resposta.
O que NÃO é considerado breaking change
Seção intitulada “O que NÃO é considerado breaking change”- Adição de um novo endpoint
- Adição de um novo campo opcional no request body
- Adição de um novo campo na resposta
- Melhoria das mensagens de erro (os códigos
codepermanecem estáveis) - Mudanças na precisão dos cálculos dentro dos limites declarados de ±1” (planetas) / ±1’ (casas)
- Aumento do rate limit ou do credit budget no teu plano
Isto significa: o teu código não deve falhar quando for adicionado um novo campo na resposta. Analisa apenas o que precisas, ignora o resto.
O QUE É breaking change (apenas em lançamentos major)
Seção intitulada “O QUE É breaking change (apenas em lançamentos major)”- Remoção ou renomeação de um endpoint
- Remoção ou renomeação de um campo na resposta
- Mudança no tipo de campo (por exemplo,
number→string) - Mudança na semântica do campo (o que o mesmo nome significa)
- Mudança no
codena resposta de erro - Endurecimento da validação, que pode quebrar pedidos anteriormente válidos
Changelog
Seção intitulada “Changelog”Todas as mudanças estão no Changelog. Lançamentos menores - a cada 2-4 semanas, patches - conforme estiverem prontos.
Subscrever atualizações:
- RSS:
https://api.astroway.info/changelog/rss.xml - Email:
Settings → Notifications → Product updatesno dashboard
Política de descontinuação
Seção intitulada “Política de descontinuação”Quando um campo ou endpoint se torna deprecated:
- Anunciamos no changelog + notificação por email
- A resposta inclui o header
Deprecation: Sun, 01 Nov 2026 00:00:00 GMT(padrão RFC 8594) - A API deprecated continua a funcionar pelo menos 12 meses
- Remoção: apenas no próximo lançamento major
Útil?
Obrigado pelo feedback.