Appearance
YAML記法の基礎
YAMLは「YAML Ain't Markup Language」の略で、人間にとって読み書きしやすいデータ記述言語です。設定ファイルやデータ交換によく使用されます。
基本構造
スカラー値
基本的な値(文字列、数値、真偽値)は以下のように記述します:
yaml
# 文字列
name: "山田太郎"
description: これは説明文です
# 数値
age: 25
price: 1000.50
# 真偽値
is_active: true
is_deleted: false
リスト(配列)
リストは -
を使って表現します:
yaml
fruits:
- りんご
- バナナ
- オレンジ
numbers:
- 1
- 2
- 3
オブジェクト(マップ)
キーと値のペアでデータを表現します:
yaml
person:
name: 山田太郎
age: 25
address:
city: 東京
postal_code: "123-4567"
高度な機能
複数行の文字列
yaml
# パイプ記号(|)を使用した複数行テキスト
description: |
これは長い説明文です。
複数行に渡って
テキストを書くことができます。
# 大なり記号(>)を使用した折り返しテキスト
address: >
東京都渋谷区
神南1-2-3
アパート101
アンカーとエイリアス
同じ内容を再利用する場合に使用します:
yaml
defaults: &defaults
timeout: 30
retries: 3
development:
<<: *defaults # defaultsの内容をコピー
host: localhost
production:
<<: *defaults # defaultsの内容をコピー
host: example.com
複数のドキュメント
一つのファイルに複数のYAMLドキュメントを含めることができます:
yaml
---
# 最初のドキュメント
name: ドキュメント1
---
# 二番目のドキュメント
name: ドキュメント2
よくある使用例
設定ファイル
yaml
server:
port: 8080
host: localhost
database:
host: db.example.com
port: 5432
credentials:
username: admin
password: secret
logging:
level: info
file: logs/app.log
環境設定
yaml
development:
database:
host: localhost
debug: true
production:
database:
host: db.production.com
debug: false
注意点
- インデントはスペースを使用し、一貫性を保つ
- コロン(
:
)の後にはスペースを入れる - 文字列に特殊文字が含まれる場合はクォートで囲む
- タブ文字は使用しない
YAMLは多くの開発現場で使用されており、特にKubernetesの設定ファイルやGitHub Actionsのワークフロー定義など、様々な場面で活用されています。