JSON-Formatter und Validator

Was ist JSON und wofür dient ein Formatter

JSON (JavaScript Object Notation) ist ein Textformat für den Datenaustausch. Es entstand aus der JavaScript-Syntax, wird aber heute von praktisch jeder Programmiersprache unterstützt und hat sich deshalb als Standard für API-Antworten, Konfigurationsdateien und die Datenübertragung zwischen Diensten etabliert. Sein Vorteil liegt darin, dass es sowohl für Menschen als auch für Maschinen lesbar ist, im Gegensatz zu binären Formaten.

Ein Formatter erfüllt zwei Aufgaben. Erstens formatiert er JSON "schön", indem er Einrückungen und Zeilenumbrüche einfügt, sodass die Struktur auf den ersten Blick erkennbar ist. Zweitens minifiziert er es, indem er alle überflüssigen Leerzeichen entfernt, was nützlich ist, wenn JSON über das Netzwerk gesendet oder in eine Datenbank geschrieben wird. Ein Validator prüft zusätzlich, ob der Text überhaupt gültiges JSON gemäß der Spezifikation ist.

Ein typisches Beispiel: Eine API gibt eine einzige lange Zeile mit Hunderten von Feldern zurück. Sie fügen diese in den Formatter ein und erhalten einen ordentlich eingerückten Baum aus Objekten und Arrays, in dem Sie sofort sehen, wo sich welches Feld befindet.

Warum mein JSON ungültig ist und wie Sie das beheben

Die meisten JSON-Fehler sind syntaktischer Natur und wiederholen sich immer wieder. JSON ist strenger als JavaScript-Objekte, daher besteht das, was im Code funktioniert, oft nicht die Validierung.

1. Komma nach dem letzten Element. {"a": 1, "b": 2,} ist kein gültiges JSON, obwohl es viele Parser in JavaScript tolerieren. Entfernen Sie dieses Komma.
2. Einfache Anführungszeichen. Schlüssel und String-Werte müssen in doppelten Anführungszeichen stehen. {'ime': 'Ana'} ist ungültig, {"ime": "Ana"} ist gültig.
3. Schlüssel ohne Anführungszeichen. {ime: "Ana"} ist kein JSON. Jeder Schlüssel muss ein String sein.
4. Kommentare. JSON unterstützt weder // noch /* */. Wenn Sie Dokumentation innerhalb der Daten benötigen, verwenden Sie ein separates Feld, zum Beispiel "_komentar".
5. Ungültige Werte. NaN, Infinity und undefined gibt es in JSON nicht. Verwenden Sie stattdessen null oder einen String.
6. Nicht übereinstimmende Klammern und fehlende Anführungszeichen. Der Validator meldet in der Regel die genaue Zeile und Spalte, beginnen Sie daher mit dem ersten gemeldeten Fehler, denn die übrigen können lediglich eine Folge davon sein.

Ein praktischer Tipp: Wenn etwas nicht funktioniert, prüfen Sie zuerst, ob das Problem in den Daten oder im Code liegt, der sie liest. Der Formatter trennt dies für Sie in wenigen Sekunden.

JSON sicher formatieren und minifizieren

Wenn JSON sensible Daten enthält, zum Beispiel Tokens, personenbezogene Daten oder eine Konfiguration mit Passwörtern, prüfen Sie, wo die Verarbeitung stattfindet. Das Tool auf evi.rs läuft in Ihrem Browser, sodass der Inhalt Ihren Computer nicht verlässt. Das ist wichtig, wenn Sie mit Produktionsdaten oder Kundendaten arbeiten.

Wenn Sie JSON minifizieren, beachten Sie, dass dadurch nur die Darstellung geändert wird, nicht die Bedeutung. Die minifizierte Version eignet sich zum Senden, ist aber schlecht für die manuelle Durchsicht und das Code Review. In der Praxis ist es sinnvoll, die formatierte Version im Repository zu speichern und die minifizierte während des Builds oder beim Senden zu generieren.

Strukturiertes JSON und die Arbeit mit KI-Modellen

Wenn ein KI-Modell Daten zurückgeben soll, die das System weiterverarbeitet, ist der zuverlässigste Ansatz, dass die Ausgabe strikt strukturiertes JSON ist. Das Modell füllt dann ein vordefiniertes Schema aus, und Sie prüfen diese Ausgabe mit einem Validator, bevor sie in die Datenbank oder die weitere Verarbeitung gelangt. Dadurch vermeiden Sie das manuelle Parsen von Freitext und die daraus entstehenden Fehler.

Ein fortgeschrittener Tipp: Definieren Sie ein Schema mit Pflichtfeldern und Typen und validieren Sie nicht nur die Syntax, sondern auch die Struktur. JSON kann syntaktisch korrekt sein und trotzdem ein Feld vermissen lassen, das Sie erwarten. Für solche Prüfungen verwenden Sie JSON-Schema-Validatoren, dieses Tool dient der schnellen Syntaxprüfung und Lesbarkeit.

Wenn Integrationen, Automatisierungen und Datenverarbeitung einzelne Tools übersteigen, kann EVI Solutions bei der Architektur und der Anbindung von Systemen helfen.