JSON do YAML

Czym jest konwersja JSON do YAML?

Konwersja JSON do YAML przekształca dane z formatu JavaScript Object Notation do YAML Ain't Markup Language. Oba formaty reprezentują te same struktury danych (obiekty, tablice, łańcuchy znaków, liczby, wartości logiczne, null), ale używają różnej składni. JSON opiera się na nawiasach klamrowych, nawiasach kwadratowych i przecinkach. YAML używa wcięć i podziałów wierszy, tworząc dane wyjściowe zbliżone do zwykłego tekstu. W odróżnieniu od XML żaden z tych formatów nie wymaga schematu.

YAML został zaprojektowany jako przyjazny człowiekowi format serializacji danych. Jest domyślnym językiem konfiguracji dla manifestów Kubernetes, plików Docker Compose, playbooków Ansible, przepływów pracy GitHub Actions i wielu systemów CI/CD. Gdy dane źródłowe są w JSON, a docelowy system oczekuje YAML, potrzebny jest konwerter, który niezawodnie zachowuje każdą wartość, typ i poziom zagnieżdżenia bez utraty danych.

Konwersja JSON do YAML online jest przydatna, gdy otrzymujesz odpowiedzi API lub wyeksportowane dane w JSON i musisz wkleić je do pliku konfiguracyjnego YAML. Konwersja jest bezstratna dla wszystkich standardowych typów JSON: łańcuchy znaków, liczby, wartości logiczne, null, tablice i obiekty mapują się bezpośrednio na ich odpowiedniki w YAML. Wartości zawierające dwukropki lub znaki specjalne są automatycznie ujmowane w cudzysłów, dzięki czemu wynik jest prawidłowym YAML.

Dlaczego konwertować JSON do YAML?

YAML to standard dla plików konfiguracyjnych; JSON to format zwracany przez API. Konwersja między nimi pozwala używać właściwego formatu do każdego zadania bez ręcznego przepisywania danych.

Przypadki użycia konwersji JSON do YAML

Porównanie JSON i YAML

JSON i YAML mogą reprezentować te same dane, ale ich składnia i możliwości różnią się w sposób istotny dla konkretnych przypadków użycia.

Pułapki YAML po konwersji

YAML ma reguły parsowania, które zaskakują deweloperów przyzwyczajonych do JSON. Te cztery problemy powodują najwięcej błędów podczas pracy z przekonwertowanymi danymi.

Przykłady kodu

Programowa konwersja JSON do YAML wymaga biblioteki do serializacji YAML w większości języków. Biblioteka standardowa obsługuje parsowanie JSON; wynik w YAML wymaga dodatkowego pakietu.

import YAML from 'js-yaml'

const json = '{"host":"localhost","port":3000,"debug":true}'
const obj = JSON.parse(json)
const yamlStr = YAML.dump(obj, { indent: 2 })
console.log(yamlStr)
// → host: localhost
// → port: 3000
// → debug: true

import json, yaml

json_str = '{"host": "localhost", "port": 3000, "debug": true}'
data = json.loads(json_str)
yaml_str = yaml.dump(data, default_flow_style=False, sort_keys=False)
print(yaml_str)
# → host: localhost
# → port: 3000
# → debug: true

package main

import (
    "encoding/json"
    "fmt"
    "gopkg.in/yaml.v3"
)

func main() {
    jsonStr := `{"host":"localhost","port":3000,"debug":true}`
    var data map[string]interface{}
    json.Unmarshal([]byte(jsonStr), &data)

    yamlBytes, _ := yaml.Marshal(data)
    fmt.Println(string(yamlBytes))
    // → debug: true
    // → host: localhost
    // → port: 3000
}

# Using yq (https://github.com/mikefarah/yq)
echo '{"host":"localhost","port":3000}' | yq -P
# → host: localhost
# → port: 3000

# Using Python one-liner
echo '{"host":"localhost","port":3000}' | python3 -c "import sys,json,yaml; print(yaml.dump(json.load(sys.stdin), default_flow_style=False))"

Często zadawane pytania