OpenAPI e Postman

OpenAPI spec

A spec OpenAPI 3.1 canônica é servida ao vivo em:

https://api.eveses.com/docs/openapi.yaml

É regenerada a cada deploy a partir dos route handlers reais, então nunca diverge do comportamento de produção. Use-a para:

• Gerar clientes em qualquer linguagem (openapi-generator-cli generate -i openapi.yaml -g python)
• Subir um servidor mock (prism mock openapi.yaml)
• Fazer diff contra sua última cópia vendoreada no CI

Navegue

O visualizador Scalar renderiza a spec como documentação interativa em:

https://api.eveses.com/docs

Experimente endpoints diretamente no navegador colando sua chave API na caixa de auth.

Postman

Importe a coleção (gerada da mesma spec):

https://api.eveses.com/docs/eveses.postman_collection.json

Vem com variáveis de ambiente eveses_api_key e eveses_base_url. Configure-as uma vez — todas as requisições ficam pré-preenchidas.

Versionamento

A spec atual é v1. Nunca quebramos endpoints v1 — adições são backward-compatible. Uma futura v2 coexistirá com v1 por pelo menos 12 meses antes do deprecation.

Inscreva-se em /changelog/api para ser notificado de adições.