OpenAPI

Die OpenAPI-Spezifikation ist ein Standardformat zur Beschreibung einer HTTP-API, sodass sie nicht nur von Menschen, sondern auch von Tools gelesen werden kann. Ein einziges Dokument listet alle Pfade und Methoden, die zugehörigen Parameter, die Anfrage- und Antworttexte als JSON-Schema, die Statuscodes und die Authentifizierungsmethoden auf. Ursprünglich hieß die Spezifikation Swagger; OpenAPI 3.1 ist die aktuelle Hauptversion.

So funktioniert es

Aus einem einzigen Dokument generieren Tools interaktive Referenzdokumente, Client-SDKs in verschiedenen Sprachen, Server-Stubs, Mock-Server und Vertragstests. Dieselbe Datei kann in der CI-Pipeline mit der laufenden API verglichen werden, sodass Beschreibung und Implementierung nicht voneinander abweichen können, ohne dass der Build fehlschlägt.

Das Missverständnis

Eine OpenAPI-Datei beweist, dass sich die API wie beschrieben verhält. Es handelt sich um eine Behauptung, nicht um einen Test: Nichts hindert einen Handler daran, ein Feld oder einen Status zurückzugeben, die in der Spezifikation nicht erwähnt werden. Ihr Wert ergibt sich aus der Überprüfung anhand realer Antworten – genau das leistet das Vertragstesting.

Probieren Sie es hier aus

Jede API hier veröffentlicht ihr eigenes OpenAPI 3.1-Dokument unter /docs/{api-id}/openapi.json , und /openapi.json umfasst den gesamten Katalog; beide werden aus denselben Definitionen generiert, die die Dokumentationsseiten rendern.

Verwandte Inhalte

• Vertragsprüfung
• JSON-Schema

Quellen

• OpenAPI 3.1 specification

Weitere Begriffe

• Vertragsprüfung — Testen, ob eine API und ihre Konsumenten sich über die Form von Anfragen und Antworten einig sind, ohne sie gleichzeitig auszuführen.
• JSON-Schema — Ein JSON-Vokabular zur Beschreibung, wie ein gültiges JSON-Dokument aussehen soll, damit Dokumente automatisch validiert werden können.
• REST-API — Eine API, die ein System als adressierbare Ressourcen modelliert, die mit Standard-HTTP-Methoden manipuliert werden.
• API-Endpunkt — Eine URL plus eine HTTP-Methode – die kleinste Einheit einer API, die ein Client aufrufen kann.
• Abfrageparameter — Die Schlüssel-Wert-Paare nach dem Fragezeichen in einer URL dienen dazu, die Ergebnisse eines Endpunkts zu filtern, zu sortieren, zu paginieren oder zu strukturieren.
• Pfadparameter — Ein variabler Abschnitt eines URL-Pfades, wie zum Beispiel die 42 in /orders/42 , der eine bestimmte Ressource identifiziert.

Diese Seite auf Englisch lesen

Alle Glossarbegriffe · Testtechniken · Alle 39 Mock-REST-APIs

Zuletzt aktualisiert 16. Oktober 2026