Что такое YAML и как он работает? Простое объяснение для новичков

Представьте, что вам нужно записать список покупок или инструкцию для друга. Вы, скорее всего, напишете это простыми словами, используя дефисы для списков и отступы для группировки. YAML — это именно такой способ записи данных, только для компьютеров. Расшифровывается как «YAML Ain't Markup Language» (YAML — это не язык разметки). Он создан для того, чтобы человек мог легко читать и писать файлы с настройками, данными или конфигурациями.

Главная идея YAML: читаемость

YAML использует отступы (пробелы) для структуры, а не скобки или теги, как в других форматах. Это делает его похожим на обычный текст. Основные строительные блоки — это пары «ключ: значение».

Основные элементы YAML

1. Пары «ключ: значение»

Самый простой элемент. Слева — имя (ключ), справа — его содержимое (значение). Ключ и значение разделяются двоеточием и пробелом.

• Пример: имя: Иван — здесь «имя» это ключ, а «Иван» — значение.
• Пример: возраст: 30 — ключ «возраст», значение «30».

2. Списки (массивы)

Чтобы перечислить несколько однотипных элементов, используется дефис и пробел перед каждым элементом.

• Пример списка покупок:

покупки:
  - молоко
  - хлеб
  - яблоки

Здесь «покупки» — это ключ, а всё, что идёт с отступом и дефисом — это элементы списка.

3. Вложенные структуры (словари)

Одно значение может быть целым набором других ключей. Для этого нужно сделать отступ (обычно 2 пробела) относительно родительского ключа.

• Пример описания человека:

человек:
  имя: Анна
  возраст: 25
  город: Москва

Ключ «человек» содержит внутри себя три других ключа: «имя», «возраст» и «город».

4. Комбинирование списков и словарей

В YAML можно легко смешивать списки и вложенные структуры. Например, список людей, где каждый человек — это набор характеристик.

• Пример:

сотрудники:
  - имя: Пётр
    должность: разработчик
  - имя: Мария
    должность: дизайнер

Здесь «сотрудники» — это список. Первый элемент списка — это словарь с ключами «имя» и «должность». Второй элемент — тоже словарь.

Правила, которые нужно запомнить

1. Используйте пробелы, не табуляцию. Табуляция может вызвать ошибку. Лучше настроить редактор так, чтобы он заменял табуляцию на 2 пробела.
2. Соблюдайте одинаковые отступы. Элементы одного уровня должны иметь одинаковое количество пробелов слева. Если у одного ключа отступ 2 пробела, а у другого 4 — YAML решит, что они находятся на разных уровнях вложенности.
3. После двоеточия всегда ставьте пробел. ключ:значение — это ошибка. Правильно: ключ: значение.
4. После дефиса в списке тоже ставьте пробел. -элемент — неверно. Правильно: - элемент.

Где используется YAML?

YAML очень популярен в мире программирования. Вы с ним точно столкнётесь, если будете настраивать:

• Файлы конфигурации Docker (Docker Compose).
• Файлы для автоматизации (GitHub Actions, GitLab CI).
• Настройки приложений (например, в Ruby on Rails или Symfony).
• Описание API (OpenAPI/Swagger).

Итог: как читать YAML

Когда вы видите YAML-файл, просто читайте его как книгу: ключи — это заголовки разделов, отступы показывают, что относится к какому разделу, а списки — это просто перечисления. Главное — не путать отступы и всегда помнить, что компьютер очень строг к пробелам. Если вы будете соблюдать эти простые правила, YAML станет для вас интуитивно понятным и удобным инструментом.