Перейти к основному содержимому

3.04. YAML

Разработчику Аналитику Тестировщику
Архитектору Инженеру

YAML

YAML (YAML Ain’t Markup Language) - формат сериализации данных, предназначенный для хранения и передачи информации. Он отличается высокой читаемостью и простотой использования, что делает его популярным выбором для конфигурационных файлов, настроек приложений и обмена данными.

Правила синтаксиса YAML

  • Вместо фигурных скобок ({}) или квадратных скобок (<>), YAML использует отступы для обозначения вложенности;
  • Отступы должны быть пробелами, а не табуляцией;
  • Табуляция запрещена в YAML;
  • Ключи и значения разделяются двоеточием (:), за которым следует пробел.
  • Значения без кавычек считаются строками;
  • Целые и дробные числа пишутся без кавычек;
  • Логические значения - true или false;
  • Нулевые значения - null;
  • Элементы списка начинаются с дефиса (-), за которым следует пробел;
  • Вложенные объекты создаются с помощью отступов;
  • Для многострочных строк используются символы | (сохраняет переносы строк) или > (объединяет строки);
  • Комментарии начинаются с символа #.

Чит-лист - https://cheatsheets.zip/yaml

Пример обычного словаря:

name: Alice
age: 25

Пример списка (упорядоченной коллекции элементов):

fruits:
- apple
- banana
- cherry

Пример вложенной структуры (сочетания словарей и списков):

server:
host: localhost
port: 8080
users:
- name: Alice
role: admin
- name: Bob
role: user

YAML применяется для конфигурационных файлов. Пример, в Docker Compose:

version: '3'
services:
web:
image: nginx
ports:
- "80:80"
db:
image: postgres
environment:
POSTGRES_PASSWORD: example

По YAML с документацией чуть более скудно, поэтому, чтобы углубиться в этот формат, в первую очередь следует ознакомиться с официальным сайтом YAML - https://yaml.org/