Blog

YAMLをJSONに変換して共通設定の展開を確かめる

YAMLで共通のタイムアウトと再試行回数を定義した例を使い、ブラウザでJSONに変換して継承された値と上書きされた値を確認する。JSONを編集してYAMLへ戻す手順と、コメントやアンカーの扱いも紹介する。

英語版のYAML ⇄ JSON変換ツールで、共通設定を参照するYAMLと値が展開されたJSONを並べた画面

共通のタイムアウトを30秒、再試行回数を2回とし、プレビュー環境だけ再試行を0回にする。YAMLでは共通設定を参照して書けるが、値がどこから来るかは設定が長くなるほど追いにくい。YAML ⇄ JSON 変換ツール でJSONに変換すると、参照を展開した結果を確かめられる。

YAMLの共通設定をJSONに展開する

左の「YAML」欄に次の例を貼り付ける。ファイルを使う場合は「YAMLファイルを読み込み(Load YAML file)」から選べる。 &defaults は共通設定に付けた名前で、<<: *defaults はその設定を preview に取り込む指定である。

# Shared request settings
defaults: &defaults
  timeoutSeconds: 30
  retries: 2
preview:
  <<: *defaults
  retries: 0

「YAML → JSON」を押す。右の「JSON」欄に結果が表示される。 preview.timeoutSeconds は共通設定を引き継いで 30 になり、preview.retries は個別の指定が優先されて 0 になる。 defaults.retries は 2 のままである。

左のYAMLでpreviewが共通設定を参照し、右のJSONのpreviewにtimeoutSeconds 30とretries 0が展開された画面
英語版の操作例。右側でpreviewの最終的な値を確認できる。

JSONを編集してYAMLに戻す

  1. 右のJSON欄で、preview の内側にある "timeoutSeconds": 30 を "timeoutSeconds": 10 に書き換える。 defaults 側は 30 のままにする。
  2. 右側の「検証: JSON → YAML → JSON(Validate: JSON → YAML → JSON)」を押す。左側に新しいYAMLが出力され、欄の下に検証結果が表示される。左の preview.timeoutSeconds が 10 になっていることを確認する。
  3. 変換結果をファイルに残す場合は、必要な欄の内容をテキストエディターにコピーして保存する。
previewのタイムアウトを10秒に変更したJSON、変換後のYAML、検証成功の表示
JSON起点の検証は、変換したYAMLを読み直し、キーの順序を除いてデータ構造や値を比較する。

コメントや型を保ちたいとき

JSONには、元のYAMLのコメントやアンカー名は入らない。このツールでは同じページ内でJSONのデータが元のYAMLと等価な場合に「JSON → YAML」を押すと、保持していた原文が戻る場合がある。今回のように値を編集すると、展開済みのデータから新しくYAMLを生成する。コメントや共通設定の参照を残してタイムアウトだけ変えたい場合は、元のYAMLの preview に timeoutSeconds: 10 を追記する。

YAML起点の「検証: YAML → JSON → YAML」は、JSONを出力してYAML原文を保持する処理である。たとえば limit: .nan は検証が成功と表示されても、JSONでは "limit": null になる。型が重要な設定を移すときは、変換後の値も直接確認する。