JSON prüfen

Was JSON tatsächlich verbietet

Die Grammatik von JSON ist bewusst winzig, und fast jeder Validierungsfehler ist eines von einer Handvoll Dingen, die man aus JavaScript übernimmt und die JSON nie übernommen hat. Ein nachgestelltes Komma nach dem letzten Element. Einfache Anführungszeichen statt doppelter. Schlüssel ohne Anführungszeichen. Kommentare – JSON hat keine und hatte nie welche. NaN und Infinity, gültige JavaScript-Zahlen, aber kein gültiges JSON. Und ein vorangestelltes Byte Order Mark, in jedem Editor unsichtbar, das manche Windows-Tools beim Speichern als UTF-8 hinzufügen und das ein einwandfreies Dokument schon am ersten Zeichen scheitern lässt.

Zwei Dinge sind erlaubt und machen trotzdem Ärger, weshalb „gültig“ nicht dasselbe ist wie „richtig“. Doppelte Schlüssel sind laut Spezifikation nicht verboten – und jeder Parser löst sie anders auf, die meisten nehmen den letzten, ein Dokument mit wiederholtem Schlüssel ist hier also gültig und bedeutet in verschiedenen Sprachen verschiedene Dinge. Und Zahlen haben in JSON keine festgelegte Genauigkeitsgrenze, während die meisten Parser sie als Gleitkommazahlen lesen: Eine Ganzzahl jenseits von etwa neun Billiarden wird stillschweigend gerundet, weshalb große IDs so oft als Strings übertragen werden.

Zurück bekommen Sie die genaue Zeile, Spalte und das Zeichen, an dem das Parsen abgebrochen ist, was meist nützlicher ist als die Meldung selbst. Ein Parser meldet die Stelle, an der das Dokument keinen Sinn mehr ergab, nicht die, an der der Fehler gemacht wurde – eine fehlende schließende Klammer wird am Dateiende gemeldet, ein fehlendes Komma beim Token danach. Direkt vor der gemeldeten Position nachzusehen ist die Gewohnheit, die am meisten Zeit spart.

Wohlgeformt ist nicht dasselbe wie richtig, und der Unterschied zählt. Diese Prüfung bestätigt, dass sich die Syntax parsen lässt. Ob das Dokument die Felder enthält, die Ihre API verlangt, ob ein Wert im zulässigen Bereich liegt, ob ein Datum wirklich ein Datum ist – nichts davon ist eine JSON-Frage. Das ist Schemavalidierung, dafür braucht es ein Schema, und ein Dokument kann hier makellos sein und vom Dienst, an den Sie es schicken, sofort abgelehnt werden.

Wenn Sie etwas anderes brauchen

Um Dokumente gegen ein Schema statt gegen eine Grammatik zu prüfen, ist JSON Schema der Standard und ajv die schnellste Implementierung – es sagt Ihnen, dass ein Pflichtfeld fehlt oder ein Wert außerhalb des Bereichs liegt, und das ist meist die Frage, die Sie tatsächlich haben. check-jsonschema führt dieselben Prüfungen auf der Kommandozeile und in der CI aus.

Für alles auf der Kommandozeile ist jq das Tool der Wahl: jq empty file.json validiert und gibt bei Erfolg nichts aus – genau richtig für ein Skript –, und jq . formatiert. Für Dateien, die zu groß für den Arbeitsspeicher sind, parsen jq --stream und Pythons ijson schrittweise, was keine Seite kann, die das ganze Dokument lädt.