Docs·OpenAPI & Postman
⚙

OpenAPI & Postman

Live OpenAPI spec, Scalar viewer, Postman collection — generate clients, mock servers, anything else.

OpenAPI spec

The canonical OpenAPI 3.1 spec is served live at:

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

It's regenerated on every deploy from the actual route handlers, so it never drifts from production behaviour. Use it to:

  • Generate clients in any language (openapi-generator-cli generate -i openapi.yaml -g python)
  • Spin up a mock server (prism mock openapi.yaml)
  • Diff against your last vendored copy in CI

Browse it

The Scalar viewer renders the spec as interactive docs at:

https://api.eveses.com/docs

Try endpoints directly in the browser by pasting your API key into the auth box.

Postman

Import the collection (generated from the same spec):

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

It ships with an environment variable eveses_api_key and eveses_base_url. Set them once, all requests are pre-filled.

Versioning

The current spec is v1. We never break v1 endpoints — additions are backward-compatible. A future v2 will live alongside v1 for at least 12 months before deprecation.

Subscribe to /changelog/api to be notified about additions.