JSON zu YAML: Regeln für Arrays und Einrückung

VeröffentlichtToolJSON-zu-YAML-Konverter

Inhalt
  1. Warum JSON in YAML umwandeln?
  2. So konvertieren Sie ohne Tool von Hand
  3. Häufige Stolperfallen beim Einfügen des Ergebnisses
  4. Zusammenfassung
  5. Häufig gestellte Fragen

Wenn Sie JSON-Daten in ein Kubernetes-Manifest oder eine Docker-Compose-Datei übernehmen möchten, müssen Sie sie im YAML-Format neu schreiben. Dabei sollten Sie wissen, wie Arrays und verschachtelte Objekte in YAML aussehen und welchen Einfluss die Wahl der Einrückungstiefe auf das Ergebnis hat. Sonst lässt sich die konvertierte Ausgabe nicht prüfen. Dieser Artikel fasst die Konvertierungsregeln zusammen und zeigt, wie Sie das Ergebnis lesen.

Zusammenfassung ① Ein JSON-Array wird in YAML zu einer Liste, deren Einträge mit einem Bindestrich (-) beginnen. Verschachtelte Objekte werden zu eingerückten Ebenen. ② Eine Einrückung von 2 oder 4 Leerzeichen dient nur der Lesbarkeit. Die Datenstruktur selbst ändert sich dadurch nicht. ③ Zeichenketten, die wie Zahlen aussehen, müssen in Anführungszeichen stehen, damit der Wert erhalten bleibt. Entfernen Sie die Anführungszeichen willkürlich, kann sich der Wert ändern.

Warum JSON in YAML umwandeln?

Kubernetes-Manifeste und Docker-Compose-Dateien verwenden das YAML-Format. Konfigurationswerte aus API-Antworten oder Datenbanken liegen dagegen häufig als JSON vor. Damit beide zusammenpassen, muss das JSON in YAML-Syntax umgeschrieben werden.

Das Problem: Beide Formate bilden Strukturen unterschiedlich ab. JSON verwendet geschweifte Klammern, eckige Klammern und Kommas, YAML dagegen Einrückung und Bindestriche.

Es reicht also nicht, einfach die geschweiften Klammern zu entfernen. Was ein Array war, muss zu einer Liste mit Bindestrichen werden, und was ein verschachteltes Objekt war, zu einer eingerückten Ebene.

Bei wenigen Konfigurationseinträgen können Sie alles von Hand neu schreiben. Je mehr Einträge es werden, desto leichter verliert man den Überblick, in welcher Ebene wie weit eingerückt werden muss. In YAML ist die Einrückung selbst Teil der Syntax: Schon ein Leerzeichen zu viel oder zu wenig, und der Eintrag wird einer anderen Ebene zugeordnet.

So konvertieren Sie ohne Tool von Hand

Die Konvertierung folgt drei Regeln. Wir wenden sie nacheinander auf das folgende JSON an.

{
  "name": "myapp",
  "port": 8080,
  "tags": ["web", "prod"],
  "database": { "host": "localhost", "port": 5432 }
}

Regel 1 – Schlüssel und Wert verbinden Sie mit Doppelpunkt und Leerzeichen. Aus "name": "myapp" wird name: myapp. Die doppelten Anführungszeichen um Zeichenketten können Sie meist weglassen.

Regel 2 – Ein verschachteltes Objekt beginnt in einer neuen Zeile und wird um eine Ebene eingerückt. Aus "database": { "host": "localhost", "port": 5432 } wird:

database:
  host: localhost
  port: 5432

Nach dem Schlüsselnamen bleibt nur der Doppelpunkt stehen. Die enthaltenen Schlüssel folgen in den nächsten Zeilen, um eine Ebene eingerückt. Die geschweiften Klammern entfallen.

Regel 3 – Bei einem Array steht vor jedem Eintrag ein Bindestrich (-), jeweils in einer eigenen Zeile. Aus "tags": ["web", "prod"] wird:

tags:
  - web
  - prod

Statt eckiger Klammern und Kommas steht jeder Eintrag in einer neuen Zeile mit Bindestrich. Enthält ein Array Objekte, steht direkt hinter dem Bindestrich der erste Schlüssel des Objekts. Die übrigen Schlüssel folgen mit derselben Einrückung.

Wenden Sie alle drei Regeln an, ergibt sich dieses Ergebnis:

name: myapp
port: 8080
tags:
  - web
  - prod
database:
  host: localhost
  port: 5432

Eine weitere Regel kommt hinzu: YAML interpretiert Werte ohne Anführungszeichen automatisch als andere Typen, etwa als Zahl oder null. Eine Zeichenkette wie 1.0, die auch als Zahl gelesen werden kann, muss deshalb in Anführungszeichen bleiben, also '1.0', damit sie eine Zeichenkette bleibt.

Auch Zeichenketten, die einen Doppelpunkt mit anschließendem Leerzeichen (: ) enthalten, müssen in Anführungszeichen stehen. Doppelpunkt und Leerzeichen trennen in YAML Schlüssel und Wert. Bleiben sie unverändert im Wert, kann ein Syntaxfehler entstehen.

Mit diesen drei Strukturregeln und der Entscheidung über Anführungszeichen können Sie auch von Hand konvertieren. Bei vielen Einträgen wird es allerdings mühsam, jedes Mal zu prüfen, wie weit eingerückt wurde und welche Zeichenketten Anführungszeichen brauchen.

Mit unserem Tool prüfen.

JSON-zu-YAML-Konverter

Wandelt Ihr eingegebenes JSON mit js-yaml in Echtzeit um. Sie können 2 oder 4 Leerzeichen Einrückung wählen. Die Nutzung ist kostenlos und ohne Anmeldung möglich.

Häufige Stolperfallen beim Einfügen des Ergebnisses

Die Konvertierung selbst folgt den Regeln. Probleme entstehen meist erst, wenn Sie das Ergebnis in eine echte Konfigurationsdatei übernehmen oder von Hand nachbearbeiten. Meist geht es um zwei Dinge: das Einrückungszeichen und die Behandlung von Anführungszeichen.

SituationWarum ist das ein Problem?Folge
Einrückung mit der Tab-TasteDie YAML-Spezifikation erlaubt keine Tabulatorzeichen zur EinrückungDer Parser meldet einen Syntaxfehler
Anführungszeichen bei zahlenähnlichen Zeichenketten entferntEntfernen Sie bei '1.10' die Anführungszeichen, wird der Wert als Zahl statt als Zeichenkette gelesenDer Wert wird zu 1.1, die abschließende 0 geht verloren
Gleichrangige Einträge einer Ebene unterschiedlich weit eingerücktYAML erkennt Einträge nur dann als gleiche Ebene, wenn sie gleich weit eingerückt sindDie Einträge werden einer anderen Ebene zugeordnet, oder es kommt zu einem Fehler
Ergebnis mit 4 Leerzeichen in eine bestehende Datei mit 2 Leerzeichen eingefügtSyntaktisch gültig, weicht aber von der bisher in der Datei verwendeten Einrückung abBei späteren Änderungen sind die Ebenen schwerer zu unterscheiden

Ob Sie 2 oder 4 Leerzeichen wählen: Die Hierarchie der Daten bleibt dieselbe. Die Einrückungstiefe verändert nur den sichtbaren Abstand. Werte und Struktur sind identisch, wenn Sie das Ergebnis wieder parsen. Wenn Sie den Text an eine bestehende Datei anhängen wollen, sollten Sie jedoch die dort verwendete Einrückung übernehmen, dann kommt später weniger durcheinander.

Auch leere Objekte ({}) und leere Arrays ([]) sollten Sie kennen. Sie werden ohne eingerückte Ebene in einer Zeile ausgegeben. Sehen Sie dort, wo Unterelemente stehen müssten, nur {} oder [] und keine Liste, ist die Konvertierung nicht fehlerhaft. Das ursprüngliche JSON enthielt an dieser Stelle einfach keinen Wert.

Zusammenfassung

  • JSON-Arrays werden zu Listen mit Bindestrich (-), verschachtelte Objekte zu eingerückten Ebenen.
  • 2 oder 4 Leerzeichen Einrückung unterscheiden sich nur im sichtbaren Abstand. Die beim Parsen entstehende Datenstruktur ist gleich.
  • Zeichenketten, die wie Zahlen aussehen, müssen in Anführungszeichen stehen, damit der Wert erhalten bleibt. Ohne Anführungszeichen kann sich der Wert ändern.
  • In YAML ist die Einrückung selbst Syntax: Tabulatorzeichen führen zu Fehlern, und Einträge derselben Ebene müssen gleich weit eingerückt sein.
  • Je mehr Einträge es gibt, desto fehleranfälliger ist die Konvertierung von Hand. Prüfen Sie das Ergebnis nach der Umwandlung deshalb noch einmal mit eigenen Augen.
JSON-zu-YAML-Konverter

Wandelt Ihr eingegebenes JSON mit js-yaml in Echtzeit um. Sie können 2 oder 4 Leerzeichen Einrückung wählen. Die Nutzung ist kostenlos und ohne Anmeldung möglich.

Häufig gestellte Fragen

Sollte ich 2 oder 4 Leerzeichen für die Einrückung wählen?

Die Datenstruktur ist identisch, die Werte sind also in beiden Fällen dieselben. In Beispielen für Kubernetes und Docker Compose sind 2 Leerzeichen recht verbreitet. Wenn Sie das Ergebnis an eine bestehende Datei anhängen wollen, sollten Sie die dort verwendete Einrückung übernehmen, damit spätere Änderungen übersichtlich bleiben.

Bei welchen Werten setzt der Konverter im YAML automatisch Anführungszeichen?

Anführungszeichen werden automatisch gesetzt bei Zeichenketten, die auch als Zahl gelesen werden könnten (z. B. 1.0, 007), und bei Zeichenketten, die einen Doppelpunkt mit Leerzeichen enthalten und deshalb unverändert anders interpretiert werden könnten. Anhand der Form des Werts wird entschieden, ob er als Zeichenkette erhalten bleiben muss.

Wie wird ein Objekt innerhalb eines Arrays dargestellt?

Direkt hinter dem Bindestrich steht der erste Schlüssel des Objekts. Die übrigen Schlüssel desselben Objekts folgen in den nächsten Zeilen, ausgerichtet auf dieselbe Spalte wie der erste Schlüssel. Zum Beispiel steht nach - name: web in der nächsten Zeile image: nginx.

Was passiert, wenn mein JSON fehlerhaft ist?

Statt eines YAML-Ergebnisses erscheint eine Fehlermeldung, dass die Syntaxanalyse fehlgeschlagen ist. Typische Ursachen sind nicht zusammenpassende geschweifte oder eckige Klammern oder falsch gesetzte Kommas. Solange der Fehler besteht, wird kein Ergebnis ausgegeben.

Dieser Artikel basiert auf unserem koreanischen Original. Koreanisches Original lesen

Ähnliche Artikel

  1. JSONPath-Syntax erklärt: Was $, [*] und .. auswählenWas $, .Eigenschaft, [Zahl], [*] und .. in JSONPath auswählen, gezeigt an einem Beispiel-JSON. Dazu: warum Filterausdrücke und Slices hier nicht greifen.
  2. JWT dekodieren: Aufbau, Payload lesen und exp in DatumJWT ist nur Base64URL-kodiert, nicht verschlüsselt. So lesen Sie Header und Payload aus und wandeln exp und iat in ein lesbares Datum um.
  3. JWT-Signatur prüfen: Warum die Verifizierung fehlschlägtSo funktioniert die JWT-Prüfung mit HMAC-SHA256: Aufbau des Tokens, Signaturberechnung und die zwei Ursachen für fehlgeschlagene Verifizierung.
  4. line-clamp in CSS: Warum es nicht funktioniert und wie es gehtWenn line-clamp nicht greift, fehlt meist display: -webkit-box. Der Artikel zeigt per Code, warum ein- und mehrzeiliges Abschneiden verschiedene Properties nutzen.
  5. Aufzählungszeichen umwandeln: Markdown, HTML und eigene SymboleSo wandeln Sie Fließtext oder Listen in Markdown-Listen, HTML-Listen mit ul und li oder eigene Aufzählungszeichen um – samt typischer Stolperstellen.
  6. Local Storage vs. Session Storage: Unterschiede im ÜberblickSpeicherdauer von Local Storage und Session Storage, Werte in den Entwicklertools prüfen und die Ursache von QuotaExceededError verstehen.

Passende Tools