JSON to YAML

Что такое конвертация JSON в YAML?

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

YAML разработан как формат сериализации данных, удобный для восприятия человеком. Это стандартный язык конфигурации для манифестов Kubernetes, файлов Docker Compose, плейбуков 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))"

Часто задаваемые вопросы