JSON formatieren und validieren (und häufige Fehler beheben)
Lerne, JSON zu formatieren, zu validieren und zu minifizieren, Parser-Fehler zu lesen und die üblichen Ursachen zu beheben, etwa Kommas am Ende.
Aktualisiert
JSON formatieren heißt, es neu einzurücken, sodass jeder Schlüssel in einer eigenen Zeile steht; validieren heißt zu prüfen, ob es der JSON-Grammatik exakt folgt. Füge den Text in einen Formatierer ein, lies den ersten gemeldeten Fehler, behebe genau diesen und lass es erneut laufen. Das meiste kaputte JSON enthält einen von etwa sechs Fehlern, und alle sind unten aufgeführt.
Was gültiges JSON wirklich verlangt
JSON ist strenger als Objektliterale in JavaScript, und dort beginnt die meiste Verwirrung. Die Regeln, auf die es ankommt:
- Schlüssel müssen Strings in doppelten Anführungszeichen sein:
{"a":1}ist gültig,{a:1}und{'a':1}sind es nicht. - String-Werte verwenden ausschließlich doppelte Anführungszeichen.
"it's"ist in Ordnung;'single'ist es nicht. - Keine Kommas am Ende.
[1,2,3,]scheitert;[1,2,3]geht durch. - Keine Kommentare.
// noteund/* note */sind beides Fehler. - Literale werden kleingeschrieben:
true,false,null.True,NULLundundefinedsind ungültig. - Zahlen dürfen keine führenden Nullen (
007) und kein führendes Plus (+5) haben und nichtNaNoderInfinitysein. - Die oberste Ebene kann ein beliebiger Wert sein, aber die meisten APIs erwarten ein Objekt
{}oder ein Array[].
Wenn du diese sieben Regeln im Kopf behältst, erkennst du das Problem meist mit bloßem Auge. Wenn nicht, nennt dir ein Validator die genaue Position.
So liest du einen Parser-Fehler
Jeder JSON-Parser meldet die Position, an der er aufgegeben hat, und das ist nicht unbedingt die Stelle, an der der Fehler liegt. Unexpected token } in JSON at position 42 bedeutet, dass der Parser auf ein } gestoßen ist, als er etwas anderes erwartet hat, typischerweise weil die vorherige Zeile mit einem Komma endet. Unexpected end of JSON input bedeutet, dass eine Klammer oder ein Anführungszeichen geöffnet und nie geschlossen wurde. Unexpected token ' bedeutet fast immer einfache Anführungszeichen.
Das praktische Vorgehen: Sieh dir die gemeldete Position an und geh dann ein Token zurück. Der JSON-Formatierer markiert den Fehler direkt an dieser Position im Text, du musst also nicht selbst Zeichen zählen.
Die häufigen Fehler beheben
Kommas am Ende
Beim Kopieren aus JavaScript, Python-Dicts oder von Hand bearbeiteten Konfigurationsdateien bleibt ein Komma nach dem letzten Element stehen. Lösche das Komma vor jedem } und ]. Linter erlauben es in JS; JSON erlaubt es nie.
Einfache Anführungszeichen und Schlüssel ohne Anführungszeichen
Die Ausgabe von print(dict) in Python, {'name': 'Ada', 'age': 36}, sieht aus wie JSON, ist aber keines. Ersetze ' durch " und setze alle nackten Schlüssel in Anführungszeichen. Wenn die Quelle Python ist, nimm json.dumps() statt str(), um echtes JSON zu bekommen.
Nicht maskierte Zeichen in Strings
Ein wörtliches doppeltes Anführungszeichen oder ein Zeilenumbruch innerhalb eines Strings muss maskiert werden: "She said \"hi\"" und "line one\nline two". Backslashes selbst werden zu \\, ein Windows-Pfad lautet also "C:\\Users\\ada". Tabs sind \t, und jeder Unicode-Codepunkt lässt sich als \u00e9 schreiben.
Kodierung und unsichtbare Zeichen
Eine Byte Order Mark am Dateianfang, typografische Anführungszeichen aus einem Dokument oder ein geschütztes Leerzeichen zwischen Tokens erzeugen verwirrende Fehler in einer Zeile, die sauber aussieht. Tippe die verdächtigen Anführungszeichen neu und speichere die Datei als UTF-8 ohne BOM.
Aneinandergehängte oder verpackte Dokumente
Logdateien enthalten oft ein JSON-Objekt pro Zeile. Die gesamte Datei ist kein gültiges JSON; jede einzelne Zeile schon. Teile an den Zeilenumbrüchen und parse jede Zeile für sich, oder fasse die Zeilen in [ und ] ein, mit Kommas dazwischen. Ebenso ist eine API-Antwort, die in einen Callback wie cb({...}) verpackt ist, JSONP; entferne also zuerst den Funktionsaufruf.
Pretty-Print und Minify im Vergleich
Schön formatiertes JSON verwendet zwei oder vier Leerzeichen pro Verschachtelungsebene und einen Schlüssel pro Zeile, und das willst du zum Lesen, für Diffs und für Konfigurationsdateien, die in git landen. Minifiziertes JSON entfernt allen Leerraum und steht in einer Zeile, und das willst du bei der Übertragung oder in einer Umgebungsvariable. Beides sind dieselben Daten. JSON.stringify(obj, null, 2) formatiert in JavaScript schön; JSON.stringify(obj) minifiziert. In Python erledigt json.dumps(obj, indent=2) dieselbe Aufgabe.
Formatieren ändert nie die Bedeutung, aber die Reihenfolge der Schlüssel wird von der JSON-Spezifikation nicht garantiert. Schreibe keinen Code, der davon abhängt, dass {"b":1,"a":2} nach einem Roundtrip in dieser Reihenfolge bleibt.Gegen ein Schema validieren
Die Syntaxprüfung sagt dir nur, dass der Text wohlgeformtes JSON ist. Sie sagt dir nicht, dass "age" eine Zahl ist oder dass "email" vorhanden ist. Dafür brauchst du JSON Schema, mit einem Validator wie Ajv in JavaScript oder jsonschema in Python. Fang mit der Syntax an, denn ein Schema-Validator kann nicht auf Text laufen, der sich nicht parsen lässt.
In andere Formate und zurück konvertieren
Tabellenkalkulationen wollen Zeilen und Spalten, keine verschachtelten Objekte. Ein Array flacher Objekte wie [{"id":1,"name":"Ada"},{"id":2,"name":"Lin"}] lässt sich sauber auf CSV mit Kopfzeile abbilden, und der JSON-zu-CSV-Konverter verarbeitet Felder in Anführungszeichen und eingebettete Kommas in beide Richtungen. Verschachtelte Objekte müssen zuerst flachgeklopft werden.
Konfigurationsdateien für Kubernetes, GitHub Actions und Docker Compose sind meist YAML. Jedes JSON-Dokument ist auch gültiges YAML, umgekehrt gilt das aber nicht, weil YAML Kommentare, Anker und Strings ohne Anführungszeichen erlaubt. Wenn sich eine YAML-Datei seltsam verhält, zeigt dir die Umwandlung mit dem YAML-zu-JSON-Konverter genau, wie der Parser jeden Wert interpretiert hat, und das deckt die klassische Überraschung auf, dass yes zu true oder 3.10 zu 3.1 wird.
Die übrigen Tools zum Formatieren, Kodieren und Validieren findest du in der Kategorie Entwickler.
Probier es aus
Füge dein fehlerhaftes JSON in den JSON-Formatierer ein. Er läuft in deinem Browser, markiert den Fehler an der genauen Position und lässt dich zwischen schön formatierter und minifizierter Ausgabe mit frei wählbarer Einrückungsbreite wechseln.