Die wichtigsten Bausteine praktisch erklärt
OpenAPI 3.1 ist der Industriestandard für REST API Dokumentation – aber viele Teams nutzen nur einen Bruchteil seiner Möglichkeiten. Dieser Guide erklärt alle wesentlichen Bausteine: von Info und Paths über Components und Schemas bis zu Security und Callbacks, mit vollständigen praxisnahen YAML-Beispielen.
Inhaltsverzeichnis
- 1. OpenAPI 3.1 vs. 3.0 – was sich geändert hat
- 2. Info, Servers und das Root-Objekt
- 3. Paths und Operations: der Kern der API
- 4. Parameters: Path, Query, Header und Cookie
- 5. Schemas mit JSON Schema 2020-12
- 6. Components: Wiederverwendung ohne Duplikate
- 7. Security Schemes: Bearer, OAuth2 und API-Key
- 8. OpenAPI 3.0 vs. 3.1 im direkten Vergleich
- 9. Zusammenfassung
- 10. FAQ