ファイルを知る、使いこなす。
.yaml
YAML設定
Web・開発YAMLはインデントで階層を表す設定・データ形式です。スペースの数や文字列の扱いが意味に影響します。YAMLの版やパーサーにより値の解釈が違う場合があるため、利用先の仕様を確認します。
- 主な用途
- 読みやすい設定・構造化データ
- 中身の種類
- テキスト
目次・よくある質問・根拠資料を見る
内容の最終確認: · 編集:Kai
開き方・操作手順
使っている環境や目的の項目を開いて、手順を確認してください。
操作名・対応状況はアプリ・OS・版によって異なります。変更する前に原本を残してください。
開けないとき:症状から確認
- インデントエラー:タブ混入や同じ階層のずれを確認します。
- yes・日付などが別の型になる:YAML版やパーサーの規則を確認し、文字列が必要なら引用符を使います。
- 読み込めるのに設定が効かない:キー名、階層、アプリの対応版を確認します。
- インデントエラー:同じ階層の空白数とタブ混入を確認します。
- yes・noが文字列にならない:YAML版とパーサーの型解釈を確認し、文字列は引用符で明示します。
- 構文は通るのに起動しない:アプリ独自の必須キー、型、パスを確認します。
YAML → JSON
- 利用するYAML版とパーサーを確認し、対象文書をデータとして読み込みます。
- JSONへ別保存し、型、配列、複数文書、アンカー等の処理結果を照合します。
- 変換前後のキー、件数、文字列・数値・日付などの型を照合し、変換できない項目は別に記録します。
コメントや表現上の情報は通常JSONへ残りません。独自タグや複雑なキーは変換できない場合があります。
型を意図どおりに読む
文字列にしたい数字、日付らしい値、yes/noなどは引用符を検討します。パーサー版の差もあるため、表示だけでなく型を確認します。
アンカーや別名は設定の重複を減らせますが、利用アプリが許す構造か確認します。
name: "example"
enabled: true
items:
- "001"
- "002"YAMLからJSONへ変換する前に
コメントやアンカーなどはJSONの同じ構造としては残りません。設定の意味を変えずに変換できるか確認します。
秘密情報を含む設定はオンライン検証へ貼り付けず、ローカルで確認します。
関連形式との違い
| 形式 | 主な役割 | 選ぶときの注意 |
|---|---|---|
| YAML / YML | インデントを使う設定・データ | 型・空白・版を確認 |
| JSON | 明示的な括弧のデータ | コメント等を保持しない |
| TOML | テーブル型の設定 | 構文と利用先が違う |
取り扱いと安全性
YAMLにはAPIキー等が入る場合があります。不明なタグやオブジェクトの復元を許す読み込み方式を避け、利用先の安全な読み込み方法を確認します。
よくある質問
タブでインデントできる?
YAMLの階層インデントにはスペースを使います。
YMLとYAMLは違う?
通常は同じ形式の拡張子違いです。
YAML 1.1と1.2は同じ解釈?
値の型などに差があるため、パーサーの対応版を確認します。
YAMLとYMLは同じ?
一般に同じ形式の表記ですが、アプリが要求するファイル名を使います。
パスのバックスラッシュに注意は必要?
引用形式によってエスケープの扱いが違います。アプリ資料の例と実際の解析結果を確認します。
形式の基本情報:正式名称・MIME type・管理団体
- 名称
- YAML Ain’t Markup Language
- 管理・仕様
- YAML language project / IETF media type registration
- MIME type
- application/yaml
公式・一次情報
- 標準仕様YAML revision 1.2.2
インデント、スカラー、配列・マッピングなどの仕様です。
YAML Project · リンク確認: - 標準仕様RFC 9512 — YAML Media Type
application/yamlの登録と.yaml・.ymlの扱いを説明しています。
IETF / RFC Editor · リンク確認: