ファイルを知る、使いこなす。
.yaml

YAML設定

Web・開発

YAMLはインデントで階層を表す設定・データ形式です。スペースの数や文字列の扱いが意味に影響します。YAMLの版やパーサーにより値の解釈が違う場合があるため、利用先の仕様を確認します。

主な用途
読みやすい設定・構造化データ
中身の種類
テキスト
目次・よくある質問・根拠資料を見る

内容の最終確認: · 編集:Kai

開き方・操作手順

使っている環境や目的の項目を開いて、手順を確認してください。

エディター:構造を確認

保存前に元ファイルのコピーを作ります。

  1. VS Code等でファイルを開き、対応する言語モードを確認します。
  2. インデント、配列、キー、引用符、コメントを確認します。
  3. 読み込み文字コードと元の改行形式を確認し、リッチテキストとして保存しないようにします。
構文確認:対象アプリのパーサー

対応YAML版や制約を確認します。

  1. 利用アプリが指定する検証方法や設定チェックを使います。
  2. タブ混入、インデント、重複キー、コロンの前後を確認します。
  3. 読まれた値の型と階層を確認し、修正後に再検証します。
設定変更:小さい差分で試す

構文とアプリの動作条件を分けます。

  1. 元設定をコピーし、変更するキーの公式説明を確認します。
  2. 対象環境のテスト設定へ変更を加え、検証を実行します。
  3. 必要な再読み込みや再起動を行い、設定値が実際に使われたか確認します。

操作名・対応状況はアプリ・OS・版によって異なります。変更する前に原本を残してください。

開けないとき:症状から確認

  • インデントエラー:タブ混入や同じ階層のずれを確認します。
  • yes・日付などが別の型になる:YAML版やパーサーの規則を確認し、文字列が必要なら引用符を使います。
  • 読み込めるのに設定が効かない:キー名、階層、アプリの対応版を確認します。
  • インデントエラー:同じ階層の空白数とタブ混入を確認します。
  • yes・noが文字列にならない:YAML版とパーサーの型解釈を確認し、文字列は引用符で明示します。
  • 構文は通るのに起動しない:アプリ独自の必須キー、型、パスを確認します。

YAML → JSON

  1. 利用するYAML版とパーサーを確認し、対象文書をデータとして読み込みます。
  2. JSONへ別保存し、型、配列、複数文書、アンカー等の処理結果を照合します。
  3. 変換前後のキー、件数、文字列・数値・日付などの型を照合し、変換できない項目は別に記録します。

コメントや表現上の情報は通常JSONへ残りません。独自タグや複雑なキーは変換できない場合があります。

型を意図どおりに読む

文字列にしたい数字、日付らしい値、yes/noなどは引用符を検討します。パーサー版の差もあるため、表示だけでなく型を確認します。

アンカーや別名は設定の重複を減らせますが、利用アプリが許す構造か確認します。

name: "example"
enabled: true
items:
  - "001"
  - "002"

この手順の根拠:YAML Project · YAML revision 1.2.2

YAMLからJSONへ変換する前に

コメントやアンカーなどはJSONの同じ構造としては残りません。設定の意味を変えずに変換できるか確認します。

秘密情報を含む設定はオンライン検証へ貼り付けず、ローカルで確認します。

この手順の根拠:YAML Project · YAML revision 1.2.2

関連形式との違い

関連形式との違い
形式主な役割選ぶときの注意
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 · リンク確認: