Ein JSON-Formatierer und ein JSON-Validator hängen zusammen, lösen jedoch nicht dasselbe Problem. Durch die Formatierung ist JSON leichter lesbar. Bei der Validierung wird geprüft, ob der JSON geparst werden kann. Bevor Sie ein Snippet in Dokumente, ein Konfigurationsfeld, ein Problem oder eine Support-Antwort einfügen, benötigen Sie möglicherweise eines oder beides.
Der JSON/YAML/TOML-Konverter von Converty hält diese Aufgaben zusammen: Validieren Sie die Eingabe, formatieren Sie sie zur Überprüfung, minimieren Sie sie, wenn eine kompakte Ausgabe wichtig ist, und konvertieren Sie sie, wenn das nächste System YAML oder TOML erwartet.
Verwenden Sie einen Formatierer, wenn der JSON schwer lesbar ist
Bei der Formatierung geht es um die Präsentation. Es fügt Einrückungen und Zeilenumbrüche hinzu, damit die Struktur leichter zu überprüfen ist.
Verwenden Sie Formatierung, wenn:
- Eine Nutzlast wird in eine Zeile minimiert
- Verschachtelte Objekte sind schwer zu verfolgen
- Ein API-Beispiel muss in der Dokumentation gezeigt werden
- Prüfer müssen Felder schnell vergleichen
- Eine Support-Antwort benötigt einen lesbaren Ausschnitt
Die Formatierung beweist nicht, dass das Beispiel semantisch korrekt ist. Es macht lediglich die Struktur sichtbar.
Verwenden Sie einen Validator, wenn der JSON möglicherweise ungültig ist
Bei der Validierung geht es um Parserbarkeit. Es erkennt Syntaxprobleme wie fehlende Kommas, nicht geschlossene Zeichenfolgen, ungültige Anführungszeichen oder fehlerhafte Verschachtelungen.
Verwenden Sie die Validierung, bevor Sie JSON in ein System einfügen, das ungültige Eingaben ablehnt. Dies ist auch vor dem Teilen von Beispielen nützlich, da ungültige Snippets die Zeit des Prüfers verschwenden und die Dokumentation weniger vertrauenswürdig machen.
Verwenden Sie beide, bevor Sie wichtige Beispiele teilen
Der sicherste Arbeitsablauf besteht darin, zuerst die Validierung und dann die Formatierung vorzunehmen. Wenn der JSON-Code nicht analysiert werden kann, beheben Sie das Problem, bevor Sie sich um die Präsentation kümmern. Sobald es gültig ist, formatieren Sie es, damit es von Menschen gelesen werden kann.
Diese Sequenz ist besonders nützlich für API-Beispiele. Für einen gezielten API-Freigabe-Workflow lesen Sie So formatieren Sie JSON vor dem Teilen einer API-Beispiel.
Wenn die Konvertierung ins Spiel kommt
Manchmal benötigt das nächste System YAML oder TOML anstelle von JSON. Die Konvertierung ist eine dritte Aufgabe, getrennt von der Formatierung und Validierung. Es ändert die Syntax und versucht gleichzeitig, die Datenstruktur beizubehalten.
Nicht jede Struktur lässt sich sauber jedem Format zuordnen, weshalb Kompatibilitätswarnungen wichtig sind. Wenn die TOML-Ausgabe nicht verfügbar ist, lesen Sie Warum die TOML-Ausgabe für einige JSON- oder YAML-Eingaben nicht verfügbar ist.
Öffnen Sie den JSON/YAML/TOML-Konverter, wenn Sie strukturierte Daten validieren, formatieren, minimieren oder konvertieren müssen, bevor Sie sie in den nächsten Workflow einfügen.
