Docs·OpenAPI & Postman
⚙

OpenAPI & Postman

Live OpenAPI-Spec, Scalar-Viewer, Postman-Collection — generiere Clients, Mock-Server, alles weitere.

OpenAPI-Spec

Die kanonische OpenAPI-3.1-Spec wird live ausgeliefert unter:

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

Sie wird bei jedem Deploy aus den tatsächlichen Route-Handlern neu generiert und driftet daher nie vom Produktionsverhalten ab. Verwende sie um:

  • Clients in beliebigen Sprachen zu generieren (openapi-generator-cli generate -i openapi.yaml -g python)
  • Einen Mock-Server zu starten (prism mock openapi.yaml)
  • Diffs gegen deine zuletzt vendored Kopie im CI zu fahren

Anschauen

Der Scalar-Viewer rendert die Spec als interaktive Dokumentation unter:

https://api.eveses.com/docs

Probiere Endpunkte direkt im Browser aus, indem du deinen API-Schlüssel in die Auth-Box einfügst.

Postman

Importiere die Collection (aus derselben Spec generiert):

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

Sie wird mit den Umgebungsvariablen eveses_api_key und eveses_base_url ausgeliefert. Einmal gesetzt — alle Requests sind vorausgefüllt.

Versionierung

Die aktuelle Spec ist v1. Wir brechen v1-Endpunkte niemals — Erweiterungen sind backward-compatible. Eine zukünftige v2 lebt mindestens 12 Monate neben v1, bevor v1 deprecated wird.

Abonniere /changelog/api, um über Erweiterungen informiert zu werden.