JSON to YAML

Що таке конвертація JSON у YAML?

Конвертація JSON у YAML перетворює дані з JavaScript Object Notation у YAML Ain't Markup Language. Обидва формати представляють однакові структури даних (об'єкти, масиви, рядки, числа, булеві значення, null), але використовують різний синтаксис. JSON покладається на фігурні дужки, квадратні дужки та коми. YAML використовує відступи та переноси рядків, що робить вивід ближчим до звичайного тексту. На відміну від XML, жоден із форматів не вимагає схеми.

YAML розроблений як зручний для читання формат серіалізації даних. Це стандартна мова конфігурації для Kubernetes-маніфестів, файлів Docker Compose, playbook-ів Ansible, робочих процесів GitHub Actions та багатьох CI/CD-систем. Коли вихідні дані у форматі JSON, а цільова система очікує YAML, потрібен конвертер, який точно зберігає кожне значення, тип і рівень вкладеності без втрати даних.

Онлайн-конвертація JSON у YAML зручна, коли ви отримуєте відповіді API або експортовані дані у форматі JSON і потрібно вставити їх у конфігураційний файл YAML. Конвертація є повністю зворотньою для всіх стандартних типів JSON: рядки, числа, булеві значення, null, масиви та об'єкти безпосередньо відображаються у їх YAML-еквіваленти. Значення, що містять двокрапки або спеціальні символи, автоматично беруться в лапки, щоб вивід був валідним YAML.

Навіщо конвертувати JSON у YAML?

YAML — стандарт для конфігураційних файлів; JSON — те, що повертають API. Конвертація між ними дозволяє використовувати правильний формат для кожного завдання без ручного переписування даних.

Сценарії використання JSON to YAML

Порівняння JSON та YAML

JSON та YAML можуть представляти однакові дані, але їх синтаксис і можливості відрізняються так, що це важливо для конкретних сценаріїв використання.

Підводні камені YAML після конвертації

У YAML є правила парсингу, які дивують розробників, що прийшли з JSON. Ці чотири проблеми спричиняють найбільше помилок при роботі з конвертованим виводом.

Приклади коду

Для програмної конвертації JSON у YAML у більшості мов потрібна бібліотека серіалізації YAML. Стандартна бібліотека обробляє парсинг JSON; для YAML-виводу потрібен додатковий пакет.

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))"

Часті запитання