Schemas

OpenAPI 3.1

Die komplette FireAPI ist als OpenAPI 3.1-Schema verfügbar. Damit erzeugst du Postman-Collections, Insomnia-Workspaces, Mock-Server oder typsichere Clients in über 50 Programmiersprachen.

Verwendung

  1. Im Workspace oben links auf Import klicken.
  2. Im Reiter Link diese URL einfügen: https://docs.fireapi.de/openapi.json
  3. Mit Continue → Import bestätigen. Postman erzeugt eine Collection mit allen Endpunkten und Beispielanfragen.
  4. Im neuen Environment den Wert apiKey hinterlegen — Postman trägt ihn automatisch in den X-FIRE-APIKEY-Header ein.
  1. Auf dem Dashboard auf Create → URL klicken.
  2. URL eintragen: https://docs.fireapi.de/openapi.json
  3. Mit Fetch and Import bestätigen. Insomnia erkennt das OpenAPI-Format automatisch und legt eine neue Collection an.

Öffne das Schema in Swagger UI, um alle Endpunkte direkt im Browser zu erkunden und interaktiv aufzurufen.

In Swagger UI öffnen

Der OpenAPI Generator erzeugt aus dem Schema typsichere Clients für beliebige Sprachen: 

npx @openapitools/openapi-generator-cli generate \
  -i https://docs.fireapi.de/openapi.json \
  -g typescript-fetch \
  -o ./fireapi-client

Verfügbare Generatoren u. a.: typescript-fetch, php, python, go, java, csharp, rust, kotlin, swift.