JSON Schema validieren

Was ist JSON-Schema-Validierung?

Bei der JSON-Schema-Validierung werden JSON-Daten mit einem Schema abgeglichen, das Struktur und Einschränkungen vorgibt. So kann beispielsweise festgelegt werden, dass ein Feld vorhanden sein muss, einen bestimmten Datentyp besitzen soll, Array-Elemente einer bestimmten Struktur entsprechen müssen oder Zahlen und Strings bestimmte Grenzen einhalten.

Was sind JSON und Schema?

Links werden die zu prüfenden JSON-Daten eingegeben, rechts das JSON Schema. JSON enthält die tatsächlichen Daten, während das Schema die Regeln beschreibt. Das Tool validiert die JSON-Daten anhand der bereitgestellten Schema-Regeln.

Welche Schema-Regeln sind üblich?

Zu den häufig verwendeten Regeln gehören type für Datentypen, required für Pflichtfelder, properties zur Beschreibung von Objektfeldern, items für Array-Elemente sowie enum, const, minimum, maximum, minLength und maxLength für Wertbeschränkungen. Der tatsächlich unterstützte Umfang richtet sich nach der Implementierung des Validators auf der Seite.

Wie liest man das Validierungsergebnis?

Eine erfolgreiche Validierung bedeutet, dass die aktuellen JSON-Daten den bereitgestellten Schema-Regeln entsprechen. Bei einer fehlgeschlagenen Validierung zeigt der Ergebnisbereich die betroffenen Positionen und Gründe an. So lassen sich fehlende Felder, falsche Datentypen oder Werte außerhalb definierter Einschränkungen schnell lokalisieren. Prüfe zunächst den Pfad und anschließend die zugehörige Schema-Regel.

Wie verwendet man required?

required legt fest, welche Eigenschaften eines Objekts vorhanden sein müssen. Wenn ein Schema beispielsweise required: ["name"] enthält, muss das JSON-Objekt eine Eigenschaft name besitzen. Dabei prüft required nur die Existenz des Feldes und legt nicht dessen Datentyp fest. Der Datentyp sollte separat über properties und beispielsweise type definiert werden.

Was sind properties und additionalProperties?

properties beschreibt konkrete Felder eines Objekts. Beispielsweise kann name als String und age als Zahl definiert werden. Mit additionalProperties lässt sich festlegen, ob zusätzliche Eigenschaften erlaubt sind, die im Schema nicht definiert wurden. Wenn unbekannte Felder verboten werden sollen, muss dies im entsprechenden Objekt-Schema ausdrücklich festgelegt werden.

Wie validiert man lokale JSON-Dateien?

Wechsle zum Datei-Upload-Tab und wähle jeweils eine lokale Datei für die JSON-Daten und das Schema aus. Die Dateien werden im Browser gelesen und zur Validierung verwendet. Dies eignet sich beispielsweise für lokale Konfigurationsdateien, API-Daten oder andere JSON-Dokumente. Die maximale Dateigröße entspricht der Angabe auf der Seite.

Wie behebt man Validierungsfehler?

Wenn ein JSON-Formatfehler angezeigt wird, sollte zuerst geprüft werden, ob die Eingabe selbst gültiges JSON ist. Wenn das JSON erfolgreich geparst werden kann, aber die Schema-Validierung fehlschlägt, sollte der angegebene Fehlerpfad geprüft werden. Häufige Ursachen sind fehlende required-Eigenschaften, ein nicht passender type, eine nicht passende Struktur von Array-Elementen gemäß items, ein Wert außerhalb von enum sowie numerische oder textbezogene Werte außerhalb definierter Grenzen.

Für welche Szenarien eignet sich JSON Schema?

JSON Schema wird häufig zur Validierung von API-Daten, Prüfung von Konfigurationsdateien, Definition von Datenverträgen zwischen Frontend und Backend, Verarbeitung von Massendaten sowie in Entwicklungs- und Testumgebungen eingesetzt. Durch die Definition einer Datenstruktur und die anschließende Validierung tatsächlicher JSON-Daten können Struktur- und Feldfehler frühzeitig erkannt werden.