Swagger UI aus Kapitel 6 zeigt die OpenAPI-Spezifikation NUR interaktiv im Browser – oft wird die ROHE Spezifikation als DATEI gebraucht, z. B. für Postman-Import oder automatisch generierte Client-SDKs.

Die Spezifikation per Konsole exportieren

docker compose exec php bin/console api:openapi:export --output var/openapi.json

Erzeugt eine VOLLSTÄNDIGE, statische openapi.json-Datei mit ALLEN aktuell registrierten Resources, Operationen und Schemas – EXAKT der gleiche Inhalt, den Swagger UI im Hintergrund ohnehin schon lädt.

YAML statt JSON

docker compose exec php bin/console api:openapi:export --output var/openapi.yaml --yaml

MANCHE Tools (z. B. bestimmte CI-Pipelines oder Dokumentationsgeneratoren) bevorzugen YAML – der --yaml-Flag erzeugt INHALTLICH identische, nur anders formatierte Ausgabe.

Die Spezifikation in Postman importieren

1. var/openapi.json aus dem Container kopieren: docker compose cp php:/app/var/openapi.json ./openapi.json
2. In Postman: "Import" → Datei auswählen.
3. Postman erzeugt AUTOMATISCH eine komplette Collection mit ALLEN Endpunkten, inklusive Beispiel-Requests.

Ein ECHTER Zeitgewinn gegenüber dem manuellen curl-Abtippen aus den vorherigen Kapiteln – besonders bei GRÖSSEREN APIs mit vielen Resources.

Client-SDKs generieren (Ausblick)

Werkzeuge wie openapi-generator-cli können aus GENAU dieser Datei TYPISIERTE TypeScript-Clients erzeugen – ein Ansatz, den wir SPÄTER (Block 9) BEWUSST NICHT wählen, da manuell geschriebene axios-Aufrufe für unser Projektformat besser NACHVOLLZIEHBAR bleiben, aber es lohnt sich zu WISSEN, dass diese Option existiert.