HTML-Tools

Kostenlose JSON-Schema-Generator und -Validator

JSON-Schema aus Beispieldaten generieren oder JSON gegen ein Schema validieren. Unterstuetzt mehrere Drafts und leitet Typen automatisch ab.

Tool wird geladen...

Was ist JSON-Schema-Generator und -Validator?

Ein zweckgerichtetes Browser-Tool fuer JSON-Schema-Workflows. Im Generierungsmodus fuegen Sie Beispiel-JSON ein und erhalten ein vollstaendiges JSON-Schema mit abgeleiteten Typen, erforderlichen Feldern und Beispielen. Im Validierungsmodus fuegen Sie JSON und ein Schema ein, um die Uebereinstimmung mit Draft 04, 07 oder 2020-12 zu pruefen. Der Schema-Generator erzeugt saubere, lesbare Schemas, die Sie weiter verfeinern koennen.

Kurze Antwort

Ein JSON-Schema aus Beispieldaten generieren (Typen ableiten, erforderliche Felder markieren) oder JSON gegen ein vorhandenes Schema validieren. Unterstuetzt Draft 04/07/2020-12. Alle Verarbeitung erfolgt lokal.

Einschränkungen

Der Schema-Generator leitet Typen aus einem einzigen Beispiel ab - er kann keine optionalen Felder, Union-Typen oder Enum-Einschraenkungen erkennen. Ueberpruefen und verfeinern Sie das generierte Schema manuell.
Validierungsfehlermeldungen sind einfach - sie zeigen den Pfad und den erwarteten Typ, schlagen aber keine Korrekturen vor oder bieten keinen detaillierten Kontext.
Der Validator unterstuetzt nicht alle JSON-Schema-Schluesselwoerter - fortgeschrittene Funktionen wie $ref, allOf/anyOf/oneOf und benutzerdefinierte Formate sind nicht vollstaendig implementiert.

So nutzt du dieses Tool

Waehlen Sie den Generierungsmodus, um ein Schema aus Beispiel-JSON zu erstellen, oder den Validierungsmodus, um Daten gegen ein Schema zu pruefen.
Fuegen Sie Ihre JSON-Daten (und das Schema bei Validierung) ein.
Waehlen Sie die benoetigte JSON-Schema-Draft-Version aus.
Kopieren Sie das generierte Schema oder ueberpruefen Sie Validierungsfehler, um Ihre Daten zu korrigieren.

Wofür du es nutzen kannst

Ein JSON-Schema aus einer API-Antwort generieren, um das erwartete Format fuer Ihr Team zu dokumentieren.
Eine Konfigurationsdatei vor der Bereitstellung gegen ihr Schema validieren, um fehlende erforderliche Felder oder falsche Typen zu erkennen.
Schnell ein Schema aus Beispieldaten erstellen und als Ausgangspunkt fuer die API-Dokumentation verfeinern.

Anwendungsfalle

Praxisbeispiele

Beispiel

API-Antwortformat dokumentieren

Ein Backend-Entwickler moechte das Antwortformat eines neuen Endpunkts dokumentieren. Er fuegt eine Beispiel-JSON-Antwort in den Schema-Generator ein und erhaelt ein vollstaendiges Draft-07-Schema mit allen Eigenschaften, Typen und Beispielen. Das Schema wird als API-Dokumentation an das Frontend-Team weitergegeben.

Beispiel

Konfiguration vor der Bereitstellung validieren

Eine CI-Pipeline prueft Konfigurationsdateien gegen ein JSON-Schema. Vor dem Commit fuegt ein Entwickler das Konfigurations-JSON und das Schema in den Validator ein und stellt fest, dass ein erforderliches Feld region fehlt. Er behebt es, bevor die CI-Prüfung es erfasst.

Haufige Fehler

Annehmen, dass das generierte Schema ein vollstaendiger API-Vertrag ist - der Generator leitet Typen aus einem einzelnen Beispiel ab, daher koennen optionale Felder fehlen oder Typen fuer reale Daten zu eng gefasst sein.
Vergessen, die richtige JSON-Schema-Draft-Version auszuwaehlen - verschiedene Tools und Plattformen unterstuetzen unterschiedliche Drafts, und die Verwendung des falschen Drafts kann zu Validierungsabweichungen fuehren.
Erwarten, dass der Validator alle semantischen Fehler erkennt - JSON-Schema validiert Struktur und Typen, aber keine Geschaeftslogik (z.B. kann er pruefen, ob ein Feld eine Zahl ist, aber nicht, ob die Zahl innerhalb eines gueltigen Bereichs liegt, es sei denn, Sie fuegen minimum/maximum hinzu).

Überprüfung

Fuegen Sie ein einfaches JSON-Objekt mit String-, Zahlen- und Boolean-Feldern ein. Generieren Sie ein Schema und ueberpruefen Sie, ob alle Typen in der Ausgabe korrekt abgeleitet wurden.
Validieren Sie ein bekanntermassen gueltiges JSON gegen sein Schema und bestaetigen Sie, dass das Tool keine Fehler meldet. Fuehren Sie dann einen Typenkonflikt ein und ueberpruefen Sie, ob er erkannt wird.

FAQ

Fragen zu JSON-Schema-Generator und -Validator

Welche JSON-Schema-Draft-Version sollte ich verwenden?

Draft 07 wird von den meisten Tools und Sprachen unterstuetzt. Draft 2020-12 ist die neueste, hat aber eine geringere universelle Tool-Unterstuetzung. Draft 04 ist aelter und wird von einigen Legacy-Systemen verwendet. Fuer neue Projekte ist Draft 07 ein sicherer Standard. Verwenden Sie Draft 2020-12, wenn Ihre Tools es unterstuetzen.

Warum markiert das generierte Schema alle Felder als erforderlich?

Der optionale Schalter steuert dieses Verhalten. Wenn aktiviert, werden alle Eigenschaften in den Beispieldaten als erforderlich im Schema markiert. Dies ist nuetzlich, wenn Ihr Beispiel einen vollstaendigen Datensatz darstellt. Deaktivieren Sie es, wenn einige Felder optional sind und Ihr Beispiel sie zufaellig enthaelt.

Kann der Validator verschachtelte Objekte und Arrays pruefen?

Ja. Der Validator prueft rekursiv verschachtelte Objekte gegen verschachtelte Schema-Eigenschaften und validiert Array-Elemente gegen die items-Definition des Schemas. Er meldet Fehler mit vollstaendigen JSON-Pfaden wie $.address.city, damit Sie genau finden, wo das Problem liegt.

Verwandte Tools