Startseite › Entwickler-Tools › <strong>Lies die Zusammenfassung</strong>: Ein grünes Häkchen bedeutet keine Fehler; andernfalls wird die Anzahl der Fehler, Warnungen und Hinweise angezeigt.

<strong>Lies die Zusammenfassung</strong>: Ein grünes Häkchen bedeutet keine Fehler; andernfalls wird die Anzahl der Fehler, Warnungen und Hinweise angezeigt.

Füge ein OpenAPI-3.0-, 3.1- oder Swagger-2.0-Dokument ein oder öffne es, um es gegen die Struktur der Spezifikation zu prüfen: Pflichtfelder, Werttypen, unbekannte Eigenschaften, $ref-Ziele, Pfadparameter, operationIds und Security-Referenzen. Jedes Problem verlinkt auf seine Zeile, und du kannst eine vollständig dereferenzierte Kopie herunterladen.

Zuletzt aktualisiert:

Laden:
Validierungsergebnis
Wird geladen…

    Klick auf ein Problem, um zu seiner Zeile zu springen. Dereferenzierte Downloads setzen jede interne $ref ein (rekursive Referenzen bleiben als $ref erhalten). Deine Spezifikation wird in deinem Browser validiert und nie hochgeladen.

    Anzeige
    Anzeige

    Anleitung: <strong>Lies die Zusammenfassung</strong>: Ein grünes Häkchen bedeutet keine Fehler; andernfalls wird die Anzahl der Fehler, Warnungen und Hinweise angezeigt.

    1. Füge deine Spezifikation in den Editor ein, öffne eine .yaml- oder .json-Datei oder lade ein Beispiel.
    2. Read the summary: a green check means no errors; otherwise the count of errors, warnings and notices is shown.
    3. Klick auf ein Problem, um zur Zeile im Editor zu springen, behebe es und sieh zu, wie sich die Liste beim Tippen aktualisiert.
    4. Filtere nach Fehlern, Warnungen oder Hinweisen, um dich zuerst auf das zu konzentrieren, was die Codegenerierung blockiert.
    5. Exportiere einen Textbericht oder lade eine dereferenzierte JSON-/YAML-Kopie herunter, in der jede interne $ref eingesetzt ist.

    Häufigste OpenAPI-Validierungsfehler und wie du sie behebst

    MeldungTypische UrsacheLösung
    Es fehlt die Pflichteigenschaft "description" (Response)Responses geschrieben als 200: {content: …}Füge jeder Response eine description: hinzu; ein kurzer Satz genügt.
    deklariert den Pfadparameter nichtPfad /users/{id} ohne passenden ParameterFüge name: id, in: path, required: true mit einem Schema auf Pfad- oder Operationsebene hinzu.
    Pfadparameter muss required: true habenrequired weggelassen (Standard ist false)Pfadparameter sind immer Pflicht: Setze required: true.
    Defekte ReferenzTippfehler oder falscher Abschnitt in $refVerwende den vorgeschlagenen Namen; 3.x verwendet #/components/schemas/X, 2.0 verwendet #/definitions/X.
    muss ein String sein, gefunden: numberversion: 1.0 oder openapi: 3.0 ohne AnführungszeichenSetze den Wert in Anführungszeichen: "1.0", oder verwende eine vollständige Version wie 3.0.3.
    Unbekannte Eigenschaft / Unbekanntes Schema-SchlüsselwortTippfehler (maxLenght), 3.1-Schlüsselwörter in 3.0 oder eigene FelderKorrigiere die Schreibweise oder setze vor eigene Felder das Präfix x-.
    Doppelte operationIdKopierte und eingefügte OperationenGib jeder Operation eine eindeutige ID in camelCase; Codegeneratoren machen daraus einen Methodennamen.
    Security-Scheme ist nicht definiertName in security weicht von securitySchemes abVerwende genau den Schlüssel, der unter components.securitySchemes definiert ist.

    OpenAPI 3.0 vs. 3.1 vs. Swagger 2.0: Regeln, die sich unterscheiden

    ThemaSwagger 2.0OpenAPI 3.0OpenAPI 3.1
    Versionsfeldswagger: "2.0"openapi: 3.0.xopenapi: 3.1.x
    Wiederverwendbare Schemasdefinitionscomponents/schemascomponents/schemas
    Request-BodyParameter mit in: body / formDatarequestBodyrequestBody
    Null-Wertenicht unterstützt (x-nullable)nullable: truetype: [string, "null"]
    pathsPflichtPflichtoptional, wenn components oder webhooks vorhanden sind
    Nachbarfelder neben $refignoriertignoriertin Schemas erlaubt; sonst summary/description
    Beispiele in Schemasexampleexampleexamples (Array) bevorzugt
    exclusiveMinimumBooleanBooleanZahl

    Du willst die Dokumentation durchsehen, sobald die Spezifikation gültig ist? Öffne sie im OpenAPI-Viewer oder bearbeite sie mit Live-Vorschau im OpenAPI-Editor.

    Häufige Fragen

    Was ist der Unterschied zwischen Fehlern, Warnungen und Hinweisen?

    Fehler verletzen die Spezifikation: Tools wie Codegeneratoren, Swagger UI oder API-Gateways lehnen die Datei möglicherweise ab oder verhalten sich unvorhersehbar. Warnungen sind gültig, aber fast sicher Versehen, etwa eine Pflichteigenschaft, die nicht definiert ist. Hinweise sind Aufräumtipps, etwa unbenutzte Komponenten oder Tags, die in der Liste auf oberster Ebene fehlen.

    Welche OpenAPI-Versionen werden unterstützt?

    OpenAPI 3.0.x, OpenAPI 3.1.x und Swagger 2.0 (OpenAPI 2.0). Das Versionsfeld entscheidet, welche Regeln gelten: Zum Beispiel sind nullable und ein boolesches exclusiveMinimum Funktionen von 3.0, während type: [string, 'null'], const und boolesche Schemas nur in 3.1 gelten.

    Warum wird „version: 1.0“ als Fehler gemeldet?

    In YAML ist eine 1.0 ohne Anführungszeichen eine Zahl, aber info.version muss ein String sein. Schreib version: "1.0" oder 1.0.0. Dasselbe gilt für openapi: 3.0, das die vollständige Version in Anführungszeichen wie 3.0.3 sein muss, und für Response-Codes wie 200, die als Schlüssel in Anführungszeichen stehen sollten.

    Löst er externe $ref-Dateien auf?

    Nein. Referenzen innerhalb des Dokuments (#/components/…) werden aufgelöst und geprüft. Referenzen auf andere Dateien oder URLs werden als Hinweise aufgeführt, weil der Browser deine anderen Dateien nicht lesen kann; bündle sie zuerst oder füge eine Spezifikation aus einer einzigen Datei ein.

    Was macht „Dereferenziert herunterladen“?

    Es ersetzt jede interne $ref durch eine Kopie des Objekts, auf das sie zeigt, und erzeugt so ein in sich geschlossenes Dokument, das manche Tools benötigen. Referenzen, die auf sich selbst zurückzeigen (rekursive Schemas), können nicht eingesetzt werden und bleiben als $ref erhalten.

    Ist das dasselbe wie die Validierung gegen das offizielle JSON Schema?

    Er prüft dieselben Strukturregeln wie die offiziellen OpenAPI-JSON-Schemas (Pflichtfelder, Typen, erlaubte Eigenschaften und Muster) und ergänzt semantische Prüfungen, die die Schemas nicht ausdrücken können, etwa ob Pfadparameter zur Vorlage passen, ob operationIds eindeutig sind und ob $refs auflösbar sind. Fehlermeldungen zeigen auf die genaue Zeile statt auf einen Schema-Pfad.

    Wird meine API-Spezifikation irgendwo hochgeladen?

    Nein. Parsen und Validieren laufen komplett in deinem Browser. Nur der Open-Source-Parser js-yaml wird von einem CDN geladen, um YAML zu lesen; deine Spezifikation verlässt nie dein Gerät.

    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 →