Что такое формат файла YAML?
.yaml - это формат текстовых файлов, используемый для обмена данными между различными приложениями. YAML (сокращение от *YAML Ain't Markup Language*) - это стандарт организации информации в человекочитаемом, платформонезависимом формате с использованием пар key: value на основе отступов, закодированных в UTF-8. Для парсинга файлов .yaml требуется установка библиотеки YAML; популярные библиотеки включают PyYAML (Python), js-yaml (JavaScript) и SnakeYAML (Java). Файлы .yaml иногда сохраняются с расширением .yml, которое функционально идентично. Помимо обмена данными, файлы .yaml обычно используются для сериализации данных и написания конфигурационных файлов в таких инструментах, как Docker Compose, Kubernetes и GitHub Actions.
Сериализация
Сериализация - это термин, используемый в информатике. Сериализация - это процесс перевода данных или объектов в формат, который можно сохранить, передать и восстановить позже. Например, два учреждения, обменивающиеся данными в стандартизированном формате с использованием разных приложений, должны сериализовать эти данные перед отправкой. Сериализованные данные также могут храниться в файле - .yaml, .xml, .json, .toml и т. д. - и затем отправляться получателям.
Документ .yaml может опционально начинаться с маркера начала документа --- и заканчиваться ...; это также позволяет размещать несколько документов внутри одного файла. Начиная с YAML 1.2 (2009 г., пересмотрен в 2021 г.), каждый валидный файл JSON также является валидным YAML.
Безопасность и защита
РИСК: MEDIUMФайл YAML является обычным текстом и не исполняется сам по себе, поэтому его чтение безопасно. Два реальных риска: (1) конфигурационные YAML (конвейеры CI, Compose, K8s, Ansible) часто содержат секреты - токены, пароли, ключи - поэтому не вставляйте их в ненадежные онлайн-валидаторы и не фиксируйте их в публичных репозиториях. (2) Программная опасность: загрузка ненадежного YAML с помощью небезопасного парсера (например, yaml.load в PyYAML вместо yaml.safe_load) может привести к выполнению произвольных объектов/кода - всегда используйте безопасный загрузчик для файлов, которым вы не доверяете. Риск при редактировании: табуляция или смещенный пробел незаметно меняют смысл, поэтому делайте валидацию после редактирования.
Детали формата
в двух словахПОЛНОЕ НАЗВАНИЕYAML Ain't Markup Language file
РАЗРАБОТЧИКClark Evans, Ingy döt Net, Oren Ben-Kiki (YAML spec)с 2001 (YAML 1.0); YAML 1.1 (2005); current YAML 1.2 (2009, revised 2021)
КАТЕГОРИЯФайлы разработчика
MIME-ТИПapplication/yaml
ТИПЧеловекочитаемый текст для сериализации данных (на основе отступов, UTF-8)
СТАНДАРТОткрытый · без роялти
Программы, открывающие файлы YAML
Windows4 apps
Sublime Text
Freemium Откройте .yaml для быстрого редактирования с подсветкой YAML; настройте «translate tabs to spaces», чтобы отступы оставались валидными. 
Windows Notepad
Встроенная Открывает YAML как текст для быстрого просмотра, но не отображает пробелы/табуляцию, поэтому редактирование чувствительного к отступам YAML в нем рискованно. 
Notepad
Открытый код Открывайте с подсветкой синтаксиса YAML; включите Вид > Отображение символов > Отображать пробелы и табуляцию, чтобы соблюдать правильность отступов. 
Visual Studio Code
Бесплатно Откройте файл; встроенное расширение или расширение Red Hat YAML обеспечивает подсветку, направляющие отступов, проверку схемы и индикацию ошибок. Лучший выбор для YAML. 
macOS3 apps
TextEdit
Встроенная Сначала выберите Формат > Сделать обычным текстом и отключите «умные кавычки», но он не покажет пробелы, поэтому для редактирования лучше использовать редактор кода.
Visual Studio Code
Бесплатно Откройте файл; встроенное расширение или расширение Red Hat YAML обеспечивает подсветку, направляющие отступов, проверку схемы и индикацию ошибок. Лучший выбор для YAML. 
Sublime Text / BBEdit
Freemium Откройте .yaml в редакторе кода для правильной подсветки YAML и отступов на основе пробелов. 
Linux3 apps
Visual Studio Code
Бесплатно Откройте файл; встроенное расширение или расширение Red Hat YAML обеспечивает подсветку, направляющие отступов, проверку схемы и индикацию ошибок. Лучший выбор для YAML.
GNOME Text Editor / gedit
Открытый код Откройте с подсветкой YAML; перед редактированием настройте вставку пробелов (не табуляции).
vim / nano
Открытый код Редактируйте в терминале; в Vim используйте «:set expandtab», чтобы в отступах использовались пробелы. Стандарт для конфигурационных файлов сервера.
Web1 app
YAML Lint / online YAML validators
Бесплатно Вставьте файл, чтобы проверить синтаксис и отформатировать его в браузере. Не вставляйте секретные данные - конфигурационные YAML часто содержат учетные данные. Технические подробности
глубокая спецификация| Расширение файла | .yaml (также .yml) |
| MIME-тип | application/yaml |
| Кодировка | UTF-8 обычный текст; без бинарного заголовка или магических байтов |
| Структура | Пары «ключ: значение» на основе отступов; в отступах используются только пробелы - табуляция запрещена спецификацией |
| Маркеры документа | --- отмечает начало документа, ... отмечает конец документа; в одном файле могут сосуществовать несколько документов |
| Собственные типы данных | Строки, целые числа, числа с плавающей запятой, логические значения, null, последовательности (списки), сопоставления (словари), временные метки |
| Версия спецификации | YAML 1.2 (2009 г., пересмотрена в 2021 г.); заменяет YAML 1.1 (2005 г.) и YAML 1.0 (2001 г.) |
| Совместимость с JSON | Начиная с YAML 1.2, каждый валидный документ JSON также является валидным YAML - JSON является строгим подмножеством |
| Комментарии | Однострочные комментарии начинаются с # ; могут располагаться на отдельной строке или внутри строки после значения |
| Многострочные строки | Литеральный блочный скаляр (|) сохраняет переносы строк; сложенный скаляр (>) преобразует переносы строк в пробелы |
| Якоря и псевдонимы | & определяет именованный якорь, а * ссылается на него (псевдоним), позволяя повторно использовать значения без дублирования |
| Разработчики | Clark Evans, Ingy döt Net, Oren Ben-Kiki |
| Общие случаи использования | Конфигурационные файлы (Kubernetes, Docker Compose, GitHub Actions, Ansible), сериализация данных, определения OpenAPI |
| Кавычки | Поддерживаются строки без кавычек, в одинарных ('...') и двойных кавычках ("..."); двойные кавычки позволяют использовать escape-последовательности |
| Выпущен | 2001 (YAML 1.0); YAML 1.1 (2005); current YAML 1.2 (2009, revised 2021) |
| Открыть стандартное | Да · без роялти |
| Спецификация | yaml.org |
Конвертации YAML
Возможно
.YAML .JSONРУКОВОДСТВО
Да - YAML и JSON используют одну и ту же модель данных, поэтому преобразование происходит без потерь;…
Как конвертировать
.YAML .XMLРУКОВОДСТВО
Yes - YAML and XML both describe hierarchical data, so conversion is straightforward, though every YAML key…
Как конвертировать
.YAML .TOMLРУКОВОДСТВО
Да, YAML можно конвертировать в TOML - самый быстрый метод это одна команда yq: yq -o=toml file.yaml >…
Как конвертировать
.YAML .CSVРУКОВОДСТВО
Yes - but only when the .yaml file is a flat, uniform list of records; nested configs such as Kubernetes…
Как конвертировать
.YAML .YMLРУКОВОДСТВО
Да - .yaml и .yml это один и тот же формат; всё, что вам нужно сделать, это переименовать файл.
Как конвертировать
Невозможно
Вопросы и ответы сообщества
спрошено пользователями
I
Часто задаваемые вопросы
В чем разница между .yaml и .yml?
Никакой - это один и тот же формат YAML с двумя расширениями. .yml - это старая трехбуквенная форма. Используйте то, которое ожидает инструмент; вы можете просто переименовать файл.
Как открыть файл .yaml?
С помощью любого редактора кода или текста. VS Code (с расширением YAML) лучше всего подходит, так как он подсвечивает структуру и отмечает ошибки отступов; Notepad++ и Sublime тоже работают. Это обычный текст, поэтому Notepad откроет его, но он не покажет пробельные символы, которые важны для YAML.
Почему мой YAML выдает ошибку отступа/парсинга?
YAML использует пробелы для структуры и запрещает табуляцию, поэтому лишний таб или смещенная строка ломают его. Откройте его в редакторе с поддержкой YAML (показать пробелы, преобразовать табы в пробелы) или вставьте его в онлайн-валидатор YAML, чтобы найти точную строку.
Как конвертировать YAML в JSON?
Используйте «yq -o=json file.yaml», команду VS Code или онлайн-конвертер. Это практически процесс без потерь, так как JSON является подмножеством YAML - отбрасываются только комментарии.
Можно ли использовать табуляцию в YAML?
Нет. YAML допускает только пробелы для отступов; табуляция вызывает ошибку парсинга. Настройте редактор на вставку пробелов (например, «:set expandtab» в Vim или «translate tabs to spaces» в Sublime).
YAML предназначен только для Python?
Нет - это распространенное заблуждение. YAML не зависит от языка и используется повсеместно: Docker Compose, Kubernetes, GitHub Actions, Ansible, приложения на Go/Java/JS и многое другое. Просто у Python есть популярная библиотека YAML (PyYAML).
Ссылки
1YAML 1.2.2 Specification (yaml.org)yaml.org
2yaml.org - official site & resourcesyaml.org
