JSON formatieren

Aus einer Zeile wird lesbarer Code

Viele APIs liefern JSON als eine einzige, lange Zeile ohne Leerzeichen oder Umbrüche, um Übertragungsvolumen zu sparen. Diese Funktion setzt Zeilenumbrüche und Einrückung an den richtigen Stellen, sodass verschachtelte Objekte und Listen auf einen Blick erkennbar werden, statt sich mühsam von Klammer zu Klammer durch eine lange Zeile zu tasten, um die Struktur überhaupt zu verstehen. Das Ergebnis lässt sich sofort weiterverwenden.

Einrückung nach Wahl

Die Einrückung lässt sich zwischen zwei Leerzeichen, vier Leerzeichen oder einem Tabulator wählen, je nachdem, welche Konvention im jeweiligen Projekt oder Team gilt. So passt sich die formatierte Ausgabe direkt an bestehende Vorgaben an, ohne dass eine nachträgliche Anpassung im eigenen Editor nötig wird, bevor die Datei ins Projekt übernommen und eingecheckt wird. Das spart gerade bei häufig genutzten Dateien wiederkehrende Handarbeit.

Wann Formatieren hilft

Beim Debuggen einer API-Antwort, bei der Dokumentation einer Datenstruktur oder beim Teilen eines JSON-Ausschnitts mit einer Kollegin macht eine lesbare Formatierung den entscheidenden Unterschied. Auch vor einem Code-Review lässt sich ein formatiertes JSON deutlich schneller überfliegen als eine einzige, zusammenhängende Zeile ohne erkennbare Struktur, in der jede einzelne Klammer zählt und leicht übersehen wird, was unnötig viel Zeit kostet und Fehler begünstigt.

Der Gegenpart: Minifizieren

Für den produktiven Einsatz, etwa als Teil einer Konfigurationsdatei in einer Anwendung, ist häufig gerade die kompakte Form gefragt, um Dateigröße zu sparen. Für diesen umgekehrten Fall steht die Minifizierung als eigene Funktion bereit, sodass sich zwischen lesbarer und kompakter Form je nach Bedarf wechseln lässt, ohne den Inhalt selbst jemals zu verändern oder Daten zu verlieren, in beide Richtungen.