Was ist ein JSON Schema?

Ein JSON Schema beschreibt, wie ein JSON-Dokument aussehen sollte: welche Eigenschaften ein Objekt hat, welche davon erforderlich sind, welchen Typ jeder Wert hat, welche Wertebereiche und Längen zulässig sind und welche Muster und Formate gelten, etwa für E-Mail-Adressen oder Datumsangaben. APIs, Konfigurationsdateien und Formular-Builder verwenden Schemas, um Daten zu prüfen, bevor sie ihnen vertrauen. OpenAPI beschreibt damit Anfrage- und Antwortinhalte.

So verwenden Sie den Validator

  1. Fügen Sie das JSON Schema in das erste Feld ein oder geben Sie es dort ein.
  2. Fügen Sie die zu prüfenden JSON-Daten in das zweite Feld ein oder geben Sie sie dort ein.
  3. Das Ergebnis wird während der Eingabe angezeigt: Entweder ist das JSON gültig, oder alle Fehler werden mit dem Pfad des fehlerhaften Werts, dem verletzten Schema-Schlüsselwort und einer kurzen Erklärung aufgelistet.
  4. Jeder fehlerhafte Wert wird in den Daten markiert. Klicken Sie auf einen Fehler, um zu der entsprechenden Stelle in den Daten zu scrollen, oder auf eine Markierung, um den zugehörigen Fehler in der Liste zu finden.

Das Feld „Schema-Version“ zeigt, anhand welcher JSON-Schema-Version die Daten geprüft wurden.

Unterstützte Versionen

Das $schema-Schlüsselwort des Schemas legt die Version fest:

  • Version 2020-12: https://json-schema.org/draft/2020-12/schema
  • Version 2019-09: https://json-schema.org/draft/2019-09/schema
  • Version 7: http://json-schema.org/draft-07/schema#
  • Version 6: http://json-schema.org/draft-06/schema#

Ein Schema ohne $schema wird anhand von Version 7 geprüft. Version 4 und ältere Versionen werden nicht unterstützt. Zunächst wird das Schema selbst anhand des Metaschemas seiner Version geprüft. Ein Tippfehler wie "type": "strin" wird daher als ungültiges Schema gemeldet und nicht ignoriert. Annotationen wie title, description und examples sind zulässig, ebenso wie Schlüsselwörter, die der jeweiligen Version nicht bekannt sind, etwa eigene x--Annotationen: Sie werden ignoriert.

Fehler verstehen

  • Pfade werden als JSONPath angegeben und beginnen mit $, dem Wurzelausdruck für das gesamte Dokument: $.ingredients[1].unit bezeichnet die Eigenschaft unit des zweiten Elements in ingredients.
  • Eine fehlende erforderliche Eigenschaft wird für das Objekt gemeldet, das sie enthalten sollte. Die Meldung nennt den Namen der Eigenschaft.
  • Eine zusätzliche, vom Schema nicht erlaubte Eigenschaft wird mit ihrem Namen angegeben.
  • Bei enum und const listet die Meldung die zulässigen Werte auf.
  • Bei anyOf und oneOf erzeugt jeder nicht erfüllte Zweig eigene Fehler, gefolgt von einem Fehler für das Schlüsselwort selbst. Ein einzelner falscher Wert kann daher mehrere Fehler verursachen.

Die Fehlermeldungen stammen aus der Ajv-Bibliothek und sind auf Englisch.

Formate

Werte mit einem format werden ebenfalls geprüft: email, uri, uri-reference, date, time, date-time, duration, uuid, ipv4, ipv6, hostname, regex, json-pointer und weitere. Ein Format, das der Validator nicht kennt, wird ignoriert, wie es die JSON-Schema-Spezifikation erlaubt.

Referenzen

$ref funktioniert für Definitionen innerhalb desselben Schemas, zum Beispiel #/$defs/address oder #/definitions/address. Verweise auf andere Dateien oder URLs werden nicht abgerufen. Ein Schema, das einen solchen Verweis benötigt, wird als ungültig gemeldet; dabei wird auch der nicht auflösbare Verweis angegeben.

Funktionsweise

Das Tool prüft mit Ajv, einem weit verbreiteten JSON-Schema-Validator, und überprüft Formate mit ajv-formats. Die gesamte Verarbeitung findet in Ihrem Browser statt: Das Schema und die Daten werden niemals hochgeladen.

Funktionen

  • JSON-Schema-Versionen 6, 7, 2019-09 und 2020-12, ausgewählt anhand von $schema
  • Jeder Fehler mit Pfad, Schlüsselwort und Meldung
  • Fehlerhafte Werte in den Daten markiert, mit Klick zum entsprechenden Eintrag
  • Formatprüfungen für E-Mail-Adressen, URIs, Datumsangaben, UUIDs, IP-Adressen und mehr
  • Schema anhand seines Metaschemas geprüft
  • Zeile und Spalte von JSON-Syntaxfehlern
  • Läuft in Ihrem Browser