Was ist OpenAPI / Swagger?
OpenAPI, früher Swagger, ist der Industriestandard zur Beschreibung von RESTful APIs. Ein OpenAPI-Dokument definiert API-Endpunkte, Anfrage- und Antwortformate, Authentifizierungsmethoden und Datenschemata in einer maschinenlesbaren YAML- oder JSON-Datei. Es wird häufig für API-Dokumentation, Client-SDK-Generierung und automatisierte Tests verwendet.
So verwenden Sie diesen OpenAPI-Viewer
- 1Fügen Sie Ihre OpenAPI-3.x-Spezifikation im YAML- oder JSON-Format in das Textfeld ein.
- 2Das Tool analysiert die Spezifikation automatisch und zeigt API-Infos, Endpunkte und Schemas an.
- 3Klicken Sie auf einen Endpunkt, um Details wie Parameter, Request Body und Antwortcodes aufzuklappen.
- 4Verwenden Sie die Filterleiste, um Endpunkte nach Pfad, Methode, Zusammenfassung oder Tag zu durchsuchen.
- 5Klicken Sie auf einen Schemanamen, um Eigenschaften und Pflichtfelder anzuzeigen.
Häufige Anwendungsfälle
Schnelle Prüfung von API-Dokumentation
Visualisieren Sie eine API-Spezifikation, ohne einen vollständigen Swagger-UI-Server starten zu müssen.
Schema-Validierung
Prüfen Sie vor der Generierung von Client-Code, ob Datenmodelle und Endpunktdefinitionen korrekt aufgebaut sind.
Zusammenarbeit am API-Design
Teilen und prüfen Sie API-Entwürfe, indem Sie Spezifikationen in Code-Reviews oder Planungsrunden direkt einfügen.
Häufig gestellte Fragen
Unterstützt das Tool auch OpenAPI 2.0 beziehungsweise Swagger?
Der Viewer ist für OpenAPI 3.x optimiert. Swagger-2.0-Spezifikationen können teilweise funktionieren, aber einige Felder wie consumes oder produces werden nicht dargestellt.
Wird meine API-Spezifikation an einen Server gesendet?
Nein. Das Parsen und Rendern erfolgt vollständig in Ihrem Browser. Es werden keine Daten hochgeladen.
Kann ich eine Spezifikation über eine URL importieren?
Derzeit müssen Sie den Inhalt direkt einfügen. Kopieren Sie die rohe YAML- oder JSON-Datei aus Ihrer Quelle oder URL und fügen Sie sie hier ein.