Versionamento
A API pública está na versão 1.0.0. Não há segmento de
versão na URL — os caminhos são estáveis sob o prefixo /public.
Versão atual
| Atributo | Valor |
|---|---|
| Versão da API | 1.0.0 |
| Versão na URL | Não utilizada (sem /v1 no caminho) |
Consultando a versão em runtime
A API expõe GET /version (fora do prefixo /public,
sem exigir chave de API) com os metadados de versão e ambiente — útil para
diagnósticos e monitoramento:
{
"success": true,
"data": { "version": "1.0.0", "environment": "production" }
}Compatibilidade
Como em qualquer API REST, trate como aditivas as mudanças que não quebram contratos. Para manter sua integração resiliente:
- Ignore campos desconhecidos. Novos campos podem ser adicionados aos objetos de resposta sem aviso; desserialize de forma tolerante.
- Não dependa da ordem das chaves em objetos JSON.
- Programe contra os campos documentados. Campos não documentados podem mudar.
- Trate os enums de forma defensiva. Por exemplo,
statusde um post pode assumirDRAFT,PUBLISHEDouSCHEDULED— embora os endpoints públicos retornem apenasPUBLISHED.