Startseite › Entwickler-Tools › OpenAPI-/Swagger-Viewer

OpenAPI-/Swagger-Viewer

Füge eine OpenAPI-(Swagger-)Spezifikation ein, lade sie hoch oder lade sie per URL, um sie als übersichtliche, durchsuchbare API-Dokumentation zu durchstöbern, in Swagger UI zu öffnen und Validierungsfehler mit genauer Position zu sehen. Funktioniert mit OpenAPI 2.0, 3.0 und 3.1 in JSON oder YAML, komplett in deinem Browser.

Zuletzt aktualisiert:

Anzeige
Anzeige

Anleitung: OpenAPI-/Swagger-Viewer

  1. Füge deine Spezifikation hinzu: Füge JSON oder YAML in den Editor ein, öffne eine openapi.yaml- / swagger.json-Datei, ziehe sie in das Feld oder lade eine öffentliche URL.
  2. Klicke auf Doku anzeigen (oder tippe einfach weiter: Die Ansicht aktualisiert sich automatisch).
  3. Durchsuche die Endpunkte: Suche nach Pfad oder Zusammenfassung, filtere nach HTTP-Methode und klicke auf eine Operation, um ihre Parameter, den Request-Body, die Antworten und Beispiel-Payloads zu sehen.
  4. Behebe Probleme: Der Tab Probleme listet Fehler und Warnungen mit dem JSON-Pfad auf, an dem sie auftreten.
  5. Öffne Swagger UI für die klassische interaktive Ansicht oder lade die Spezifikation als JSON oder YAML umgewandelt herunter.

Aufbau eines OpenAPI-Dokuments

AbschnittOpenAPI 3.xSwagger 2.0
Versionsfeldopenapi: 3.0.3 oder 3.1.0swagger: "2.0"
API-Detailsinfo (title und version erforderlich)info
Basis-URLservers[].urlschemes + host + basePath
Endpunktepaths (in 3.1 mit Webhooks optional)paths
Request-BodyrequestBody.content pro Medientypein Parameter mit in: body
Wiederverwendbare Schemascomponents.schemasdefinitions
Authentifizierungcomponents.securitySchemessecurityDefinitions
Antwortschemaresponses.200.content['application/json'].schemaresponses.200.schema

Häufigste Validierungsfehler

  • Pfadparameter nicht definiert: Jedes {id} in einem Pfad braucht einen passenden Parameter mit in: path und required: true, entweder an der Operation oder am Path Item.
  • Defekte $ref: ein Tippfehler in #/components/schemas/Name oder ein umbenanntes Schema. Referenzen unterscheiden Groß- und Kleinschreibung.
  • Antwort ohne description: description ist in 2.0 und 3.x bei jedem Response-Objekt Pflicht, auch wenn es ein leerer String ist.
  • Version oder Statuscodes in YAML ohne Anführungszeichen: Schreibe "200" und version: "1.0" in Anführungszeichen, damit YAML sie nicht in Zahlen umwandelt.
  • Doppelte operationId: Codegeneratoren verwenden sie für Methodennamen, daher muss jede eindeutig sein.
  • Arrays ohne items: type: array braucht ein items-Schema.

OpenAPI 3.0 vs. 3.1

OpenAPI 3.1 gleicht Schemas an JSON Schema 2020-12 an: type darf ein Array wie [string, "null"] statt nullable: true sein, examples ist ein Array, exclusiveMinimum ist eine Zahl, und ein Dokument darf nur webhooks oder components ohne paths enthalten. Dieser Viewer akzeptiert beide Stile und wendet die passenden Regeln für die im Dokument angegebene Version an.

Häufige Fragen

Was ist der Unterschied zwischen Swagger und OpenAPI?

Swagger 2.0 wurde in OpenAPI Specification umbenannt, als es 2016 an die OpenAPI Initiative überging. OpenAPI 3.0 (2017) und 3.1 (2021) sind die neueren Versionen. Swagger bezeichnet heute die SmartBear-Tools wie Swagger UI und Swagger Editor, die mit OpenAPI-Dateien arbeiten.

Welche Versionen unterstützt dieser Viewer?

Er liest Swagger-/OpenAPI-2.0-Dokumente (swagger: "2.0") sowie OpenAPI-3.0.x- und 3.1.x-Dokumente (openapi: "3.x.x"), geschrieben in JSON oder YAML.

Was prüft der Validator?

Pflichtfelder wie info.title, info.version, paths und responses; Pfadschlüssel und Pfadparameter; Parameterpositionen; doppelte operationIds; defekte lokale $ref-Verweise; unbekannte Sicherheitsschemas; ungültige Schematypen und Arrays ohne items. Es ist eine praxisnahe Strukturprüfung, keine vollständige JSON-Schema-Validierung der Spezifikation.

Wird meine API-Spezifikation hochgeladen?

Nein. Die Spezifikation wird in deinem Browser eingelesen und dargestellt. Nur die optionale Swagger-UI-Ansicht lädt die Swagger-UI-Bibliothek von einem öffentlichen CDN, und der URL-Loader ruft die Adresse ab, die du eingibst. Nichts wird an FreeToolCabin gesendet.

Warum schlägt das Laden von einer URL fehl?

Der Browser kann eine Spezifikation von einer anderen Website nur lesen, wenn dieser Server Cross-Origin-Anfragen (CORS) erlaubt. Schlägt das Laden fehl, öffne die URL in einem neuen Tab, speichere die Datei und öffne sie hier oder füge ihren Inhalt ein.

Werden externe $ref-Dateien unterstützt?

Verweise innerhalb desselben Dokuments (beginnend mit #/) werden aufgelöst. Verweise auf andere Dateien oder URLs werden als Warnungen aufgeführt und nicht verfolgt, da der Viewer nur das eine Dokument hat, das du bereitstellst.

Werden alle Tools auf FreeToolCabin auf Qualität und Genauigkeit getestet?

Ja. Jedes Tool auf der Website durchläuft automatische Tests in echten Browsern, die prüfen, ob das Ergebnis stimmt und keine Fehler auftreten. Wenn du einen Fehler findest oder einen Vorschlag hast, schreib uns an [email protected] – wir sehen es uns an.

Ähnliche Tools

Alle Code-Generatoren & Builder ansehen →