JSON-Daten gegen ein Schema validieren

Wofür die Prüfung geeignet ist

Mit dem JSON Schema Validator prüfen Sie, ob ein JSON-Dokument zu einem vorgegebenen JSON Schema passt. Dazu fügen Sie den JSON-Inhalt und das zugehörige Schema als Text in die beiden vorgesehenen Eingabefelder ein und starten die Prüfung. Das eignet sich zum Beispiel, wenn Sie vor der Weiterverarbeitung feststellen möchten, ob Datentypen, Pflichtfelder oder einfache Wertebereiche eingehalten werden. Beide Eingaben sind optional und werden standardmäßig als leerer Text behandelt. Für ein aussagekräftiges Ergebnis sollten Sie jedoch Daten und Schema vollständig einfügen.

JSON gegen ein Schema prüfen

JSON-Daten vorbereiten: Kopieren Sie das zu prüfende JSON-Dokument in das Eingabefeld für die Daten. Achten Sie auf gültige JSON-Syntax, etwa doppelte Anführungszeichen bei Zeichenketten und korrekt gesetzte Kommata.
Schema einfügen: Fügen Sie das JSON Schema in das separate Schemafeld ein. Darin können Sie unter anderem Typen wie string, number, integer, boolean, object und array deklarieren.
Prüfung starten: Übermitteln Sie beide Texte an die Prüfung. Die Anwendung versucht zunächst, beide Eingaben als JSON zu lesen. Erst danach wird das Datenobjekt anhand des Schemas validiert.
Regeln gezielt wählen: Für Objekte können deklarierte Eigenschaften rekursiv geprüft und erforderliche Eigenschaften verlangt werden. Wenn zusätzliche Eigenschaften im Schema deaktiviert sind, können nicht deklarierte Eigenschaften abgelehnt werden. Bei Arrays lässt sich die Prüfung auf die Elemente anwenden. Ergänzend sind beispielsweise enum, minimale und maximale Zahlenwerte sowie minimale und maximale Zeichenlängen möglich.
Ergebnis kontrollieren: Prüfen Sie neben dem Gültigkeitsstatus auch die angegebenen Details. So erkennen Sie, ob ein Eingabefeld fehlt, die JSON-Syntax nicht gelesen werden konnte oder eine Schema-Regel verletzt wurde. Leere oder nur aus Leerzeichen bestehende Daten beziehungsweise ein leeres Schema führen zu einem ungültigen Ergebnis mit einem Hinweis auf die fehlende Eingabe.

Ergebnis richtig einordnen

Ein gültiges Ergebnis bedeutet, dass die übergebenen Daten die von dieser Prüfung berücksichtigten Schema-Regeln erfüllen. Bei einem ungültigen Ergebnis lesen Sie die Details schrittweise: Zuerst sollten Sie prüfen, ob beide Texte vorhanden und syntaktisch gültig sind. Danach kontrollieren Sie Datentypen, fehlende erforderliche Eigenschaften, nicht erlaubte zusätzliche Eigenschaften sowie Grenzen für Zahlen oder Zeichenlängen.

Der Status der Operation ist dabei nicht dasselbe wie die Gültigkeit der Daten. Auch bei fehlenden Eingaben, einem Parse-Fehler oder einer fehlgeschlagenen Validierung kann die Operation selbst erfolgreich abgeschlossen werden; maßgeblich für Ihre Entscheidung ist deshalb der separate Gültigkeitsstatus.

Die Prüfung deckt die im Laufzeitverhalten beschriebenen Typ- und Regelkontrollen ab. Daraus folgt nicht, dass jede Funktion des JSON-Schema-Standards unterstützt wird. Behandeln Sie ein gültiges Ergebnis daher als Aussage über die angewendeten Regeln und nicht als Nachweis einer vollständigen Standardabdeckung.

Praktisches Beispiel

Sie möchten vor dem Import eines Kundenobjekts prüfen, ob die Kunden-ID den im Schema deklarierten Typ erfüllt.

Sie fügen ein JSON-Objekt mit einer Kunden-ID und ein Schema ein, das diese Eigenschaft als Zeichenkette verlangt, und starten anschließend die Prüfung.

Das Ergebnis weist die Daten als gültig oder nicht gültig aus und ergänzt den Status bei Bedarf um Validierungsdetails, etwa zu fehlenden Eigenschaften oder einem Datentyp.

Einschränkungen

Die Aussage gilt für die im geprüften Verhalten berücksichtigten Typ- und Schema-Regeln. Sie belegt keine vollständige Unterstützung sämtlicher JSON-Schema-Funktionen.

Häufige Fehler

Ursache: Ein Feld enthält nur Leerzeichen oder einen Text, der kein gültiges JSON bildet. Korrektur: Fügen Sie sowohl das JSON-Dokument als auch das Schema vollständig ein und prüfen Sie vor dem Start Syntax, Anführungszeichen und Klammern.

Häufige Fragen

Kann ich JSON-Daten ohne Schema prüfen?

Ja, sofern beide Texte gültiges JSON ergeben und die Daten die berücksichtigten Regeln erfüllen. Bei leerer oder nur aus Leerzeichen bestehender Eingabe wird das Ergebnis als nicht gültig ausgewiesen.

Welche Regeln kann das Schema prüfen?

Die Prüfung verarbeitet unter anderem Zeichenketten, Zahlen, Ganzzahlen, boolesche Werte, Objekte und Arrays, auch in verschachtelten Werten. Zusätzlich können beispielsweise Enumerationen, Zahlenbereiche und Zeichenlängen begrenzt werden.

Warum wird mein JSON als ungültig gemeldet?

Ein ungültiges Ergebnis kann durch fehlende Pflichtfelder, nicht erlaubte zusätzliche Eigenschaften, einen falschen Datentyp oder einen Verstoß gegen eine Werte- beziehungsweise Längengrenze entstehen. Lesen Sie dafür die Validierungsdetails aus.