Softonic

OpenAPI Spec Validator online

Schritt 1 / 2
Weiter

Fügen Sie Ihre OpenAPI- oder Swagger-Spezifikation oben ein, um eine Liste mit Fehlern und Warnungen zu erhalten. Diese Seite erklärt, was jede Meldung bedeutet und wie Sie sie beheben, damit Sie schnell von einem roten Bericht zu einem sauberen kommen. Fehler machen das Dokument ungültig, Warnungen nicht.

So prüfen Sie eine Spezifikation und handeln nach dem Bericht

  1. 1

    Spezifikation einfügen

    Fügen Sie Ihr Dokument als JSON oder YAML in das Feld ein.

  2. 2

    Ergebnisse öffnen

    Wechseln Sie zum Schritt Ergebnisse, um entweder eine Gültigkeitsmeldung oder eine Fehlerliste zu sehen.

  3. 3

    Jede Meldung zuordnen

    Suchen Sie die Meldung in der Tabelle unten und setzen Sie die Korrektur in Ihrer Quelldatei um.

  4. 4

    Erneut einfügen

    Wiederholen Sie die Prüfung, bis keine Fehler mehr bestehen, und entscheiden Sie dann, welche Warnungen sich zu beheben lohnen.

Fehlermeldungen lesen

Meldung Bedeutung Korrektur
Konnte nicht als JSON oder YAML gelesen werden. Der Text ist in keinem der beiden Formate lesbar Syntax korrigieren: überzählige Kommas, falsche Einrückung, nicht geschlossene Klammern
Versionsfeld ‘openapi’ oder ‘swagger’ fehlt. Kein Versionsschlüssel auf oberster Ebene openapi: 3.0.3 oder swagger: "2.0" ergänzen
Objekt ‘info’ fehlt. Kein Abschnitt info info mit Titel und Version ergänzen
info.title ist erforderlich. info hat keinen Titel Einen title unter info ergänzen
info.version ist erforderlich. info hat keine Version Eine version unter info ergänzen (Ihre API-Version)
Objekt ‘paths’ fehlt. Kein Abschnitt paths paths ergänzen, auch wenn es zunächst leer ist

Fehler entscheiden darüber, ob das Dokument als gültig gilt. Beheben Sie zuerst alle.

Warnungen lesen

Meldung Bedeutung Korrektur
Der Pfad ‘x’ sollte mit ‘/’ beginnen. Ein Schlüssel unter paths hat keinen führenden Schrägstrich Umbenennen in /x
Unbekannte Methode ‘x’ bei /pfad. Ein Schlüssel unter einem Pfad steht nicht auf der bekannten Liste Auf Tippfehler prüfen oder ignorieren, wenn es eine bewusste Erweiterung oder trace ist

Die bekannte Liste umfasst get, post, put, patch, delete, head, options, parameters, summary, description und servers. Herstellererweiterungen, die mit x- beginnen, stehen nicht darauf und erscheinen daher ebenfalls als Warnungen.

Was eine Online-Prüfung nicht erkennen kann

Der Bericht betrifft nur die Struktur. Er folgt keinen $ref-Verweisen, prüft keine Schemadefinitionen und meldet keine fehlenden operationId-Werte. Ein Bestehen bedeutet, dass die Datei die Form eines OpenAPI-Dokuments hat. Verwenden Sie vor der Veröffentlichung von Dokumentation oder der Erzeugung von Client-Code einen vollständigen Linter.

Tipps zur Arbeit mit einem langen Bericht

Beginnen Sie oben: Ein Parserfehler bedeutet, dass alles Weitere unzuverlässig ist, also beheben Sie ihn zuerst. Danach kümmern Sie sich um fehlende Felder auf oberster Ebene, denn die sind schnell ergänzt. Erst dann sehen Sie sich die Pfadwarnungen an. Fügen Sie nach jeder Runde von Änderungen die gesamte Datei erneut ein und nicht nur einen Ausschnitt, denn die Prüfungen brauchen das vollständige Dokument, um info und paths zu finden. Ein Bericht ohne Fehler und mit einigen bewussten Warnungen ist ein völlig normales und akzeptables Ergebnis.

Häufig gestellte Fragen

Fehler bedeuten, dass das Dokument als ungültig gilt. Warnungen weisen auf Punkte hin, die einen Blick wert sind, etwa einen Pfad ohne führenden Schrägstrich, verändern das gültige Ergebnis aber nicht.

Nicht unbedingt. Es bedeutet, dass die Struktur auf oberster Ebene stimmt. Schemas, Verweise und Antworten werden nicht geprüft.

Schlüssel unter einem Pfad werden mit einer festen Liste von HTTP-Methoden und einigen Feldern des Pfadelements verglichen. Ein Schlüssel mit x- steht nicht darauf und wird deshalb als Warnung markiert. Sie können ihn stehen lassen.

Nein. Sie folgen der Reihenfolge der Prüfungen: zuerst das Versionsfeld, dann info, dann paths. Es gibt keine Zeilennummern.

Verwandte Tools

Zufallsbuchstaben-Generator

Erzeugen Sie zufällige A-Z-Buchstaben. Wählen Sie Anzahl, Großschreibung, Kleinschreibung oder gemischte Schreibweise für Spiele, Aufgaben und Unterricht.

FPS-Zähler

Browser-FPS mit requestAnimationFrame messen: Glättung, minimale und maximale Bildrate, Warnschwelle und optionales Diagramm. Läuft lokal, ohne Upload und ohne API.

XSD-Validator

Validieren Sie ein XML-Dokument gegen ein XSD-Schema und melden Sie Element- und Typfehler mit genauen Zeilennummern.

ASCII-Tabelle Referenz

Vollständige ASCII-Tabelle von 0 bis 127 mit Dezimal-, Hex-, Oktal-, Binär- und numerischer HTML-Zeichenreferenz für jedes Zeichen, einschließlich Steuerzeichen wie NUL, LF und DEL.

HTML-Zeichenreferenz

Durchsuchbare Liste von HTML-Entitäten, ihren benannten und numerischen Codes sowie eine Ein-Klick-Kopie für Sonderzeichen und Symbole.

Markdown-Spickzettel

Praktische Markdown-Referenz mit echten Vorschauen und kopierfertigen Beispielen für Überschriften, Listen, Tabellen, Code, Links, Bilder und GFM-Syntax.

Tool in anderen Sprachen verfügbar

Anleitungen und Anwendungsfälle