Was bedeutet OpenAPI?
Eine Beschreibung nennt beispielsweise verfügbare Aufrufe, Eingabefelder, Antworten und Zugangsverfahren. Werkzeuge können daraus Dokumentation, Testgrundlagen oder Programmgrundgerüste erstellen.
Die Beschreibung führt die Schnittstelle nicht selbst aus. Sie muss mit der tatsächlichen Anwendung übereinstimmen und ihre fachlichen Regeln ausreichend erklären. Ein formal korrektes OpenAPI-Dokument beweist noch keine korrekte Umsetzung.
So sieht das in der Praxis aus
Beispiel: Ein OpenAPI-Dokument legt die Anfragen und möglichen Antworten einer Rechnungs-API fest.
Häufige Fragen
Ist OpenAPI dasselbe wie Swagger?
OpenAPI ist die Spezifikation, Swagger bezeichnet dazugehörige Werkzeuge wie Swagger UI. Historisch hieß die Spezifikation selbst Swagger; daraus entsteht häufig die Verwechslung.
Kann OpenAPI zur Erzeugung von Programmcode genutzt werden?
Geeignete Werkzeuge können Grundgerüste oder Clients erzeugen. Geschäftslogik und vollständige Fehlerbehandlung müssen trotzdem passend entwickelt und geprüft werden.
Wie verhindert man veraltete Dokumentation?
Beschreibung, Implementierung und Tests sollten gemeinsam gepflegt werden. Automatisierte Prüfungen und klare Verantwortung helfen, Abweichungen zwischen Vertrag und tatsächlichem Verhalten zu erkennen.