1 Funktionsweise
Eine YAML/JSON-Spezifikation definiert Pfade und Datenmodelle. Tools generieren Dokumentation, SDKs oder Validierung daraus und halten Vertrag und Implementierung näher zusammen.
- Paths & Operations: was die API kann
- Schemas: Request-/Response-Modelle
- Security Schemes: z. B. OAuth, API-Keys
2 Typische Einsatzbereiche
- API-Design und Review im Team
- Automatische Docs und Mock-Server
- Contract Tests und Gateway-Policies
3 Wichtige Hinweise
- Spec und Code müssen synchron bleiben (Lint/CI).
- Versionierung der API klar abbilden.
- Beispiele und Fehlercodes gehören zur guten Spec.
4 Fazit
OpenAPI macht REST-Verträge explizit und automatisierbar – Grundlage für nachhaltigen API-Betrieb statt reiner Text-Wiki-Doku.