OpenAPI / Swagger

OpenAPI & Swagger

OpenAPI ist ein Standard zur Beschreibung von REST-Schnittstellen. Swagger bezeichnet die Werkzeuge, die um diesen Standard herum entwickelt wurden.

Kernkomponenten

• OpenAPI Specification (OAS): Eine YAML- oder JSON-Datei, die Endpunkte, Parameter, Authentifizierung und Rückgabewerte einer API definiert.
• Swagger UI: Ein Tool, das die OAS-Datei in eine interaktive Webseite verwandelt, auf der man die API direkt testen kann.
• Swagger Codegen: Erlaubt das automatische Generieren von Client-SDKs oder Server-Stubs in verschiedenen Sprachen.

Eignung

• API-Dokumentation: Standardisierung der Kommunikation zwischen Frontend- und Backend-Teams.
• Test-Automatisierung: Validierung von API-Requests gegen die Spezifikation.
• Contract-First Design: Erst die API planen, dann den Code schreiben.