YAMLの書き方と文法の例
YAMLは設定ファイルで最もよく使われる形式です。エラーなく読み書きするために必要なルールをまとめました。
基本の要素
| 要素 | YAMLの書き方 | 意味 |
|---|---|---|
| マッピング | 名前: web | キーと値の組 |
| 入れ子のマッピング | 子のキーをスペース2つ下げる | オブジェクトの中のオブジェクト |
| リスト | - 最初の項目 | リストの1項目 |
| 1行のリスト | [a, b, c] | 1行で書く短いリスト |
| コメント | # メモ | プログラムは無視する |
| ヌル | ~、null、または空 | 値なし |
複数行の文字列
| を使うと改行をそのまま残せるので、スクリプトや証明書に向いています。> を使うと行が1つの段落にまとめられ、長い説明文に向いています。記号の後に - を付ける（|- や >-）と最後の改行が削除されます。
アンカーと複数ドキュメント
- 値の前に&名前を書いて印を付け、後で*名前と書くと再利用できます。
- <<: *名前で、再利用するマッピングを別のマッピングに結合できます。
- 1つのファイル内の複数ドキュメントは、ハイフン3つ（---）の行で区切ります。
- ツールが明示的な終わりを必要とする場合は、...でドキュメントを終えます。