YAMLは「人間に読みやすい」データ形式
プログラムの設定ファイルなどでよく使われます。
見た目がシンプルで、箇条書きのメモのように直感的に理解できるのが特徴です。
3つの基本ルール
① キー: 値
「項目名」と「その内容」をコロン(:)で繋ぎます。コロンの後には半角スペースが必要です。
② インデント(字下げ)
半角スペース2つ分の字下げで、データの階層(親子関係)を表現します。
③ ハイフン(-)
ハイフン(-)を使って、リスト(複数の項目)を表現します。ハイフンの後にも半角スペースが必要です。
具体例で見てみよう
ユーザーのプロフィール情報をYAMLで書いてみます。
📄 user_profile.yml
name: "山田 太郎"
age: 30
is_premium_member: true
address:
# インデントで階層化
prefecture: "東京都"
city: "新宿区"
hobbies:
# ハイフンでリストを表現
- 読書
- 映画鑑賞
- プログラミング
email: null # 値がない場合はnull
キーと値: name: "山田 太郎"
のように、項目とその値を設定します。
階層構造: address
の下に、prefecture
や city
がぶら下がっています。インデント(字下げ)が親子関係を示します。
リスト: hobbies
には複数の趣味が並んでいます。ハイフン(-
)でリストを表します。
データ型: 文字列、数値、true
/false
(真偽値)、null
(空)など、様々な種類のデータを扱えます。
コメント: #
から始まる行はコメントとして扱われ、プログラムからは無視されます。メモを残すのに便利です。
どこで使われるの?
⚙️
設定ファイル
アプリケーションの動作設定
🐳
Docker
docker-compose.yml
⛵
Kubernetes
マニフェストファイル
🚀
CI/CDツール
GitHub Actionsなど