YAML設定
Web・開発YMLはYAML設定・データで使われる拡張子です。たとえば自動処理やサービス設定では、構文が正しくてもキー名や階層が違うと機能しません。利用アプリの設定例と照合し、スペースによるインデント、引用符、YAML版による値の型を確認します。設定に含まれるパスワードやAPIキーの共有にも注意が必要です。
- 主な用途
- 読みやすい設定・構造化データ
- 中身の種類
- テキスト
目次・よくある質問・根拠資料を見る
内容の最終確認： · 編集：Kai
開き方・操作手順
使っている環境や目的の項目を開いて、手順を確認してください。
操作名・対応状況はアプリ・OS・版によって異なります。変更する前に原本を残してください。
開けないとき：症状から確認
- インデントエラー：タブ混入や同じ階層のずれを確認します。
- yes・日付などが別の型になる：YAML版やパーサーの規則を確認し、文字列が必要なら引用符を使います。
- 読み込めるのに設定が効かない：キー名、階層、アプリの対応版を確認します。
- キーが上書きされたように見える：同じ階層の重複キーを探し、利用パーサーの扱いを確認します。
- 長い本文の改行が変わる：
|と>による複数行値の扱いを確認します。 - 一部文書だけ読まれる：
---で区切る複数文書に利用先が対応するか確認します。
YAML → JSON
- 利用するYAML版とパーサーを確認し、対象文書をデータとして読み込みます。
- JSONへ別保存し、型、配列、複数文書、アンカー等の処理結果を照合します。
- JSON化後、文字列、数値、nullと配列の階層を元の設定と比較します。
コメントや表現上の情報は通常JSONへ残りません。独自タグや複雑なキーは変換できない場合があります。
同じ文字列に見える値を区別
郵便番号や製品番号は計算用数値と用途が異なります。引用符、利用パーサーと読み込み後の値を照合し、桁や先頭ゼロを確認します。
確認例：商品番号00123は計算用数値とは違います。文字列として保持したい場合は引用符と読込後の型を確認し、先頭ゼロが残るか比較します。
この手順の根拠：YAML Project · YAML revision 1.2.2 / IETF / RFC Editor · RFC 9512 — YAML Media Type
アンカーと秘密情報の受け渡し
アンカーで同じ値を参照している設定は、変換後の構造を確認します。共有用コピーでは認証情報を確認し、値を伏せた部分を説明します。
この手順の根拠：YAML Project · YAML revision 1.2.2 / IETF / RFC Editor · RFC 9512 — YAML Media Type
関連形式との違い
| 形式・方法 | 役割 | 確認する点 |
|---|---|---|
| YML / YAML | 階層を持つ設定 | 型・版・インデント |
| JSON | 厳密なデータ表現 | コメントやタグ |
| アプリ設定検証 | 設定の意味を確認 | 有効なキー |
取り扱いと安全性
YAMLにはAPIキー等が入る場合があります。不明なタグやオブジェクトの復元を許す読み込み方式を避け、利用先の安全な読み込み方法を確認します。
よくある質問
タブでインデントできる？
YAMLの階層インデントにはスペースを使います。
YMLをYAMLへ改名してよい？
形式は通常同じですが、アプリが決められた名前の設定ファイルを探す場合があります。利用先の指定に従います。
YAML 1.1と1.2は同じ解釈？
値の型などに差があるため、パーサーの対応版を確認します。
構文チェックが通れば設定は正しい？
アプリが知らないキーや誤った階層でも構文上は成立します。設定仕様と実際の反映結果を確認します。
コメントはJSONへ残る？
通常のデータ変換では残りません。説明も必要なら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 · リンク確認：