Was ist OpenAPI
Spezifikation zur Beschreibung von REST APIs
OpenAPI ist eine Standardspezifikation zur Beschreibung von REST APIs, die automatisierte Dokumentation und Codegenerierung ermöglicht.
OpenAPI-Vorteile
- Einheitlicher API-Beschreibungsstandard
- Automatisch generierte Dokumentation
- Client-Code-Generierung
- Anfrage- und Antwortvalidierung
Hauptkomponenten
- Info — API-Metadaten
- Paths — Endpunkte und Operationen
- Components — wiederverwendbare Schemas
- Security — Authentifizierungsmethoden
- Servers — Basis-URLs
Werkzeuge
- Swagger UI — interaktive Dokumentation
- Swagger Editor — Spezifikationseditor
- OpenAPI Generator — Codegenerierung
- Redoc — alternative Dokumentation