JSON gegen ein JSON Schema validieren

Ein JSON Schema ist selbst ein JSON-Dokument, das beschreibt, wie ein anderes JSON-Dokument aufgebaut sein soll. Während die reine Syntaxprüfung nur klärt, ob ein Dokument wohlgeformt ist, geht die Schema-Validierung einen Schritt weiter und prüft die inhaltliche Struktur. Im Schema legen Sie fest, welche Eigenschaften ein Objekt haben darf, welche davon Pflicht sind und welchen Datentyp jeder Wert annehmen muss, etwa Zeichenkette, Zahl, Wahrheitswert, Objekt oder Array. So definieren Sie einen Vertrag, den ein Dokument einhalten muss, um als gültig zu gelten. Der Validierer nimmt Ihr JSON und Ihr Schema entgegen und prüft, ob das Dokument diesem Vertrag entspricht. Auf diese Weise stellen Sie sicher, dass Daten nicht nur formal korrekt sind, sondern auch die erwartete Form und Bedeutung haben.

Zwei der wichtigsten Prüfungen betreffen Pflichtfelder und Datentypen. Über das Schlüsselwort required geben Sie im Schema an, welche Eigenschaften zwingend vorhanden sein müssen. Fehlt eine davon im Dokument, meldet der Validierer genau diese fehlende Eigenschaft. Über das Schlüsselwort type legen Sie fest, welchen Typ ein Wert haben muss. Steht im Schema, dass ein Feld eine Zahl sein soll, im Dokument aber eine in Anführungszeichen gesetzte Zeichenkette, gilt das als Verstoß, obwohl das JSON syntaktisch einwandfrei ist. Genau hier zeigt sich der Mehrwert der Schema-Validierung gegenüber der reinen Syntaxprüfung. Der Validierer nennt die betroffene Eigenschaft und die verletzte Bedingung, sodass Sie erkennen, ob das Dokument angepasst werden muss oder ob das Schema die Realität Ihrer Daten noch nicht korrekt abbildet.

Ein JSON Schema kann weit mehr ausdrücken als nur Pflichtfelder und Typen. Sie können zulässige Wertebereiche für Zahlen festlegen, eine Mindest- oder Höchstlänge für Zeichenketten fordern, erlaubte Werte über eine Aufzählung einschränken oder Muster für Zeichenketten über reguläre Ausdrücke beschreiben. Auch die Elemente eines Arrays lassen sich über ein eigenes Teilschema prüfen, sodass jede Position denselben Regeln folgt. Für verschachtelte Objekte definieren Sie wiederum eigene Eigenschaften mit ihren Typen. Je genauer Sie das Schema formulieren, desto aussagekräftiger ist die Validierung. Der Validierer arbeitet die im Schema hinterlegten Bedingungen ab und meldet jede Stelle, an der das Dokument abweicht. So verwandeln Sie ein informelles Verständnis davon, wie Ihre Daten aussehen sollen, in eine überprüfbare und wiederholbare Regel, die Sie auf beliebig viele Dokumente anwenden können.

Sowohl Ihr JSON-Dokument als auch Ihr Schema werden ausschließlich in Ihrem Browser verarbeitet. Nichts davon wird an einen Server gesendet, gespeichert oder ausgewertet. Das ist gerade bei Schemata relevant, denn ein Schema beschreibt oft das interne Datenmodell einer Anwendung und verrät damit einiges über deren Aufbau. Da die gesamte Validierung lokal abläuft, bleiben sowohl die Beispieldaten als auch die Struktur privat. Sie brauchen keine Anmeldung und kein Konto, es gibt kein Wasserzeichen und keine Nutzungsbegrenzung. Der Validierer ist sofort einsatzbereit, sobald die Seite geladen ist, und funktioniert in jedem modernen Browser ohne Installation. Diese lokale Verarbeitung macht ihn zu einer sicheren Wahl, wenn Sie sensible Datenmodelle prüfen möchten, ohne sie einer externen Stelle anzuvertrauen.

Bevor eine Schema-Validierung überhaupt sinnvoll ist, muss das JSON syntaktisch gültig sein. Ein Dokument mit einem fehlenden Komma oder einer offenen Klammer lässt sich nicht gegen ein Schema abgleichen, weil es sich nicht einmal in eine Datenstruktur umwandeln lässt. Prüfen Sie deshalb zuerst die reine Syntax und erst danach die Übereinstimmung mit dem Schema. Dasselbe gilt für das Schema selbst, das ebenfalls gültiges JSON sein muss. Ist beides wohlgeformt, kontrolliert der Validierer die inhaltlichen Regeln. Diese Reihenfolge hilft Ihnen, Fehlerquellen sauber zu trennen: ein Syntaxfehler im Dokument, ein Fehler im Schema oder ein echter Verstoß gegen die geforderte Struktur. Wenn Sie diese Ebenen auseinanderhalten, finden Sie die Ursache eines Problems deutlich schneller und wissen genau, an welcher Stelle Sie ansetzen müssen.