OpenAPI-Spezifikations-Viewer

Analysiere und erkunde OpenAPI/Swagger-Spezifikationen mit Endpunkt-Navigation, Schema-Inspektion und cURL-Generierung. Kostenlos, schnell und vollständig im Browser, ohne Anmeldung.

Aktualisiert am

Share:
Home/Developer Tools/OpenAPI Spec Viewer

OpenAPI Spec Viewer

Parse and explore OpenAPI/Swagger specifications with endpoint browsing, schema inspection, and cURL generation.

OpenAPI Specification

Häufig gestellte Fragen

Was ist der OpenAPI-Spezifikations-Viewer?

Der OpenAPI-Spezifikations-Viewer ist ein kostenloses Online-Tool, das OpenAPI-/Swagger-Spezifikationen analysiert und erkundet, mit Endpoint-Navigation, Schema-Inspektion und cURL-Generierung. Er läuft vollständig in deinem Browser, ohne Installation oder Anmeldung.

Welche Versionen?

OpenAPI 3.x und Swagger 2.0, sowohl in JSON als auch in YAML. Das Format wird automatisch erkannt.

Exportieren?

Exportiere als JSON oder YAML, unabhängig vom Eingabeformat. Kopiere die vollständige Spezifikation in die Zwischenablage.

cURL-Generierung?

Klicke auf einen beliebigen Endpoint und verwende Als cURL kopieren. Erzeugt den Befehl mit Server-URL, Methode, Headern und Platzhaltern für den Body.

Ist der OpenAPI-Spezifikations-Viewer kostenlos nutzbar?

Ja, der OpenAPI-Spezifikations-Viewer ist zu 100 % kostenlos, ohne Registrierung, ohne versteckte Gebühren und ohne Nutzungslimits. Die gesamte Verarbeitung erfolgt lokal in deinem Browser und gewährleistet vollständige Privatsphäre.

Sind meine Daten mit diesem Tool sicher?

Absolut. Der OpenAPI-Spezifikations-Viewer verarbeitet alles clientseitig in deinem Browser. Es werden keine Daten auf einen Server hochgeladen oder dort gespeichert. Deine Inhalte bleiben jederzeit privat auf deinem Gerät.

Funktioniert der OpenAPI-Spezifikations-Viewer auf Mobilgeräten?

Ja, der OpenAPI-Spezifikations-Viewer ist vollständig responsiv und funktioniert auf Smartphones und Tablets. Du kannst ihn auf jedem Gerät mit einem modernen Webbrowser nutzen, ganz ohne App-Download.

Muss ich ein Konto erstellen, um dieses Tool zu nutzen?

Es ist kein Konto und keine Registrierung erforderlich. Öffne einfach den OpenAPI-Spezifikations-Viewer in deinem Browser und beginne sofort mit der Nutzung. Es gibt keine Anmeldeschranken oder Nutzungsbeschränkungen.

Welche Programmiersprachen oder Formate werden unterstützt?

Der OpenAPI-Spezifikations-Viewer unterstützt eine breite Palette beliebter Formate und Sprachen. In der Tool-Oberfläche findest du die vollständige Liste der unterstützten Optionen.

Wie verwende ich den OpenAPI-Spezifikations-Viewer?

Gib einfach deine Eingabe in das vorgesehene Feld ein, passe die Einstellungen nach Wunsch an, und das Tool verarbeitet sie sofort. Anschließend kannst du das Ergebnis in die Zwischenablage kopieren oder herunterladen.

Was ist der Unterschied zwischen OpenAPI und Swagger?

Swagger war der ursprüngliche Name der Spezifikation, und Version 2.0 wird immer noch häufig „Swagger" genannt. 2016 wurde das Format an die OpenAPI Initiative gespendet und in OpenAPI umbenannt, weshalb Version 3.x korrekt als OpenAPI bezeichnet wird. Heute meint „Swagger" meist das Tooling — Swagger UI, Swagger Editor, Codegen —, während „OpenAPI" das Spezifikationsdokument selbst bezeichnet. Beide gehören zur selben Familie: Beide beschreiben die Endpunkte, Parameter, Request Bodies, Antworten und Datenmodelle einer REST-API in einer einzigen JSON- oder YAML-Datei. Die wichtigste strukturelle Änderung in 3.x ist, dass Body-Parameter und Response-Modelle in einen wiederverwendbaren Abschnitt „components/schemas" verschoben wurden und aus „definitions" „schemas" wurde. Dieser Viewer liest sowohl Swagger 2.0 als auch OpenAPI 3.x, erkennt automatisch, welche Version Ihr Dokument verwendet, und stellt es auf dieselbe Weise dar — fügen Sie also einfach eines der beiden Formate ein, um es zu erkunden.

Kann ich eine OpenAPI-Spec von YAML nach JSON konvertieren?

Ja. Da der Viewer Ihre Spezifikation im Speicher in ein strukturiertes Objekt parst, kann er dasselbe Dokument in jedem Serialisierungsformat zurückgeben, unabhängig davon, wie Sie es eingefügt haben. Fügen Sie eine YAML-Spec ein und nutzen Sie „Export JSON", um eine korrekt formatierte JSON-Version herunterzuladen, oder fügen Sie JSON ein und nutzen Sie „Export YAML", um das eingerückte YAML-Äquivalent zu erhalten — die API-Beschreibung, Endpunkte und Schemas bleiben identisch, nur die Syntax ändert sich. Das ist praktisch, wenn ein Build-Tool, ein Mock-Server oder ein Client-Generator ein bestimmtes Format erwartet, Ihr Team die Spec aber im anderen Format verfasst hat. Sie können das gesamte konvertierte Dokument auch direkt in Ihre Zwischenablage kopieren. Alles läuft lokal in Ihrem Browser, sodass selbst eine interne oder unveröffentlichte Spec Ihren Rechner nie verlässt. Fügen Sie Ihre Datei ein und wählen Sie das gewünschte Exportformat.

Wie erkennt der Viewer, ob meine Spec JSON oder YAML ist?

Das Format wird automatisch anhand des ersten Zeichens ungleich Leerzeichen erkannt. Beginnt Ihr eingefügter Text mit einer öffnenden geschweiften Klammer, wird er als JSON behandelt und entsprechend geparst; alles andere wird als YAML geparst, da gültiges JSON für eine Spec immer mit einem Objekt beginnt. Nach dem Parsen prüft der Viewer, ob ein Feld „openapi" oder „swagger" vorhanden ist, um zu bestätigen, dass es sich um eine echte Spezifikation und nicht um beliebige Daten handelt. Schlägt das Parsen fehl — ein versehentlicher Tab, ein fehlendes Anführungszeichen, falsche Einrückung —, zeigt er die genaue Fehlermeldung statt eines leeren Bildschirms, damit Sie das Problem schnell finden und beheben können. Das bedeutet, Sie müssen ihm nie mitteilen, welches Format Sie verwenden, oder vorher Kommentare entfernen. Fügen Sie einfach den rohen Inhalt Ihrer Spec-Datei ein, und der Viewer erledigt den Rest und stellt die API dar.

Wie geht der Viewer mit $ref-Referenzen zwischen Schemas um?

OpenAPI-Specs vermeiden Wiederholungen, indem sie Modelle einmal unter „components/schemas" definieren und an anderer Stelle mit „$ref"-Referenzen darauf verweisen — eine Antwort könnte auf ein Pet-Schema verweisen, das seinerseits auf eine Category und ein Array von Tags verweist. Im Schemas-Tab stellt der Viewer jedes Modell als aufklappbaren Baum dar und löst diese „$ref"-Verweise zu dem Modell auf, auf das sie zeigen, sodass Sie sich durch verschachtelte Objekte und Arrays klicken können, statt sich durch rohen Text zu scrollen und nach Definitionen zu suchen. Jede Eigenschaft zeigt ihren Typ, ihr Format, ob sie erforderlich ist, und etwaige Enum-Optionen, was die tatsächliche Struktur jedes Modells auf einen Blick klar macht. Das erspart Ihnen das manuelle Abgleichen verschiedener Teile der Datei, um zu verstehen, wie die Daten zusammenpassen. Öffnen Sie den Schemas-Tab nach dem Parsen Ihrer Spec, um die Modellbeziehungen visuell nachzuvollziehen.

Warum werden HTTP-Methoden und Statuscodes in unterschiedlichen Farben angezeigt?

Die Farbcodierung ist eine Lesehilfe, mit der Sie eine große API überfliegen können, ohne jedes Label lesen zu müssen. Jede Operation trägt ein Methoden-Badge — GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS —, farblich nach Verb unterschieden, sodass sichere Lesezugriffe von Schreib- und Löschoperationen abstechen, wenn Sie eine lange, nach Tag gruppierte Liste von Endpunkten überfliegen. Innerhalb eines aufgeklappten Endpunkts sind Response-Statuscodes nach Klasse eingefärbt: 2xx Erfolg, 3xx Weiterleitungen, 4xx Client-Fehler und 5xx Server-Fehler sind jeweils auf einen Blick unterscheidbar, sodass Sie sofort sehen, welche Antworten eine Operation liefern kann. Veraltete Operationen werden separat markiert, damit Sie nicht gegen einen Endpunkt entwickeln, der ohnehin bald wegfällt. Zusammen verwandeln diese Hinweise eine dichte Spec in etwas, das Sie schnell einordnen können. Fügen Sie eine Spec ein oder laden Sie das eingebaute Petstore-Beispiel, um das Farbschema in Aktion zu sehen.

Über den OpenAPI Spec Viewer

Der OpenAPI Spec Viewer macht aus einer rohen API-Spezifikation eine lesbare, durchsuchbare Referenz. Fügen Sie ein OpenAPI-3.x- oder Swagger-2.0-Dokument ein — egal ob als JSON oder YAML — und der Viewer parst es, fasst die API zusammen, listet jeden Endpunkt gruppiert nach Tag auf und lässt Sie in Parameter, Request Bodies, Response-Schemas und Modell-Definitionen eintauchen. Entwickelt für Backend- und Frontend-Entwickler, QA-Ingenieure und technische Redakteure, die eine Spec-Datei erhalten und die API schnell verstehen müssen, ohne einen eigenen Dokumentationsserver aufzusetzen.

Das Format wird automatisch erkannt: Eingaben, die mit { beginnen, werden als JSON behandelt, alles andere wird als YAML geparst. Anschließend prüft der Viewer, ob das Feld openapi oder swagger vorhanden ist, um zu bestätigen, dass es sich wirklich um eine Spezifikation handelt — schlägt das Parsen fehl, zeigt er die genaue Fehlermeldung statt eines leeren Bildschirms. Haben Sie keine Spec zur Hand, lädt ein eingebautes Petstore-Beispiel ein vollständiges OpenAPI-3.0-Dokument, damit Sie sehen können, wie alles dargestellt wird.

Was Ihnen der Viewer zeigt

Sobald eine Spec geparst ist, zeigt ein API-Informationsfeld den Titel, die Version, die Spec-Version (OpenAPI 3.x oder Swagger 2.0), die Beschreibung und alle deklarierten Server. Eine Statistikzeile zählt die Gesamtzahl der Endpunkte, schlüsselt sie nach HTTP-Methode auf und gibt an, wie viele wiederverwendbare Schemas definiert sind. Von dort aus gliedern zwei Tabs die Details:

  • Endpunkte — jede Operation gruppiert unter ihrem Tag, mit farbcodierten Methoden-Badges (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS). Klicken Sie auf einen Endpunkt, um Zusammenfassung, Operation-ID, Parameter (mit ihrem Ort — Path, Query, Header — Typ und ob sie erforderlich sind), Request Body und die vollständige Liste der Antworten aufzuklappen. Response-Statuscodes sind nach Klasse farbcodiert, sodass 2xx, 3xx, 4xx und 5xx auf einen Blick unterscheidbar sind, und veraltete Operationen werden markiert.
  • Schemas — die Modelle aus dem Abschnitt components/schemas, dargestellt als aufklappbarer Baum. Jede Eigenschaft zeigt ihren Typ, ihr Format, eine Pflichtfeld-Markierung und Enum-Optionen, und $ref-Referenzen werden zu dem Modell aufgelöst, auf das sie verweisen — so folgen Sie verschachtelten Objekt- und Array-Strukturen, ohne sich durch rohen Text zu scrollen.

Einen cURL-Befehl aus jedem Endpunkt generieren

Einen Endpunkt zu lesen ist das eine, ihn aufzurufen das andere. Jeder aufgeklappte Endpunkt besitzt eine Schaltfläche „Copy as cURL", die einen lauffähigen Befehl zusammenstellt — aus der ersten Server-URL der Spec, der korrekten HTTP-Methode, dem Request-Pfad, Header-Parametern als -H-Flags und, bei Operationen mit Request Body, dem Content-Type plus einem -d '{}'-Platzhalter zum Ausfüllen. Das liefert Ihnen einen funktionierenden Ausgangspunkt zum direkten Einfügen in ein Terminal oder einen HTTP-Client, statt die Anfrage von Hand aus der Dokumentation abzutippen.

Die Spec exportieren und konvertieren

Da der Viewer das Dokument in ein strukturiertes Objekt parst, kann er es in jedem gewünschten Format zurückgeben. Exportieren Sie die vollständige Spezifikation als JSON oder als YAML, unabhängig davon, in welchem Format sie eingegeben wurde, oder kopieren Sie die gesamte Spec in Ihre Zwischenablage. Das macht den OpenAPI Spec Viewer neben einem Reader auch zu einem schnellen YAML-zu-JSON- (oder JSON-zu-YAML-) Konverter für API-Definitionen.

Datenschutz und Funktionsweise

Alles geschieht in Ihrem Browser. Die Spec wird auf Ihrem eigenen Gerät mit clientseitigem JavaScript geparst, geprüft und konvertiert — nichts wird an einen Server hochgeladen, es gibt kein Konto zu erstellen und keine Nutzungslimits. Das ist wichtig, wenn die API-Definition intern oder noch unveröffentlicht ist: Eine private Spec mit Endpunkten, Auth-Schemata und Datenmodellen bleibt auf Ihrem Rechner. Sobald die Seite geladen ist, funktioniert sie auch offline weiter, und große Spezifikationen werden im Tempo Ihrer eigenen Hardware verarbeitet statt in einer entfernten Warteschlange.