YAMLをJSONに変換する方法|手作業のルールと注意点

設定ファイルは YAML で書いておくことが少なくありません。インデントだけで構造が見え、コメントも自由に書けるので、人が読んで直す分には YAML のほうがずっと楽です。ところが、その値を JavaScript のコード内で使ったり、API リクエストの本文にそのまま入れようとした瞬間、YAML のままでは使えないことに気づきます。
まとめ ① YAML は人が読み書きしやすい一方、JavaScript のオブジェクトや API リクエスト本文は JSON 形式を前提としています ② インデントによる構造を波かっこ・角かっこによる構造へ移すルールさえ分かれば、手作業でも変換できます ③ ネストが深い YAML やリストが混ざった YAML は手作業での変換ミスが起きやすいため、結果を目で検証する工程が必要です
YAML の設定は、なぜコードでつまずくのか
YAML はインデントで階層を表し、コロンの後ろに値を書く方式なので、人が読むのに向いています。コメント(#)も自由に書けるため、設定ファイルの形式として広く使われています。
問題は、JavaScript の JSON.parse や fetch のリクエスト本文などが、YAML の文法を理解しないという点です。これらの関数が解釈できるのは、JSON 文法である波かっこ、角かっこ、二重引用符で囲んだキーだけです。
そのため、設定ファイルにある値をテスト用の API リクエストにそのまま貼り付けたり、フロントエンドのコード内に定数として移そうとしたりすると、構文エラーになります。YAML 自体は文法的に何の問題もないのに、JSON を前提とする場所ではエラーになるわけです。
確認する方法: 手作業で変換するルールと検証
手作業で変換するときのルールは 3 つです。1 つ目は、key: value を二重引用符で囲んだ形に変えること。2 つ目は、インデントで表された下位項目を波かっこで囲むこと。3 つ目は、行頭に付くリスト項目を角かっこの配列に変えることです。
| YAML 表記 | JSON 表記 |
|---|---|
| host: localhost | 二重引用符で囲んだキーと値 |
| インデントでまとめた下位項目 | 波かっこで囲む |
| 行頭のリスト項目 | 角かっこの配列に変える |
| true、false、null、数値 | 引用符なしでそのまま維持 |
ルールは単純ですが、階層が 2〜3 段を超えると、かっこの対応を手で合わせるのは簡単ではありません。リストの中にさらにオブジェクトが入っている構造なら、かっこが重なってミスが起きやすくなります。
当サイトの無料ツールで確認する。 YAML を入力欄に貼り付けると、下に JSON の結果がすぐに作られ、インデント幅を 2 スペース・4 スペース・1 行(圧縮)から選んで、そのままコピーしてコードに貼り付けられます。
無料・登録不要・ブラウザ上ですぐにJSON変換

よくつまずくポイント
| 状況 | なぜつまずくのか |
|---|---|
| リストの中にオブジェクトが混ざった構造 | 角かっこの中に波かっこが重なり、手で対応を合わせるのが難しいからです |
| 文字列にコロンや引用符が含まれる | エスケープ処理をしないと構文エラーになります |
| タブとスペースを混ぜたインデント | 階層の解釈が変わり、意図しない構造に変換されます |
| 最後の項目の後ろにカンマが残っている | JSON は最後の項目の後ろのカンマを許可していません |
表にまとめた状況は、目で流し見しただけではなかなか気づけず、実際にパースを試して初めてエラーの位置が見えます。変換後には、構造が元と同じかどうかを一度確認する習慣が必要です。
まとめ
YAML は設定を人が読み書きしやすい形式で、JSON はコードと API が理解する形式です。コロンを引用符に、インデントを波かっこに、リストを角かっこに変えれば、手作業でも移せます。
ただし階層が深くなったり、リストとオブジェクトが混ざったりすると、かっこの対応を合わせる途中でミスをしがちです。そんなときは、変換結果をその場で目視検証できるツールを使ったほうが早く済みます。
無料・登録不要・ブラウザ上ですぐにJSON変換
よくある質問
YAML のすべての文法を JSON に変換できますか?
key-value、ネストしたマップ、リストのように設定ファイルでよく使う構造は、そのまま JSON に移せます。ただしアンカーや参照といった YAML 固有の文法は JSON に対応する概念がないため、先に値を展開した状態にしてから変換する必要があります。
変換した JSON は API リクエスト本文にそのまま使えますか?
標準的な JSON 構造になっていれば、fetch や axios のリクエスト本文にそのまま入れられます。ただし、API が期待するフィールド名や値の型が元の YAML のキーと一致しているかは、別途確認が必要です。
インデント幅は 2 スペースと 4 スペースのどちらを選べばよいですか?
パースされたデータ自体は、インデント幅に関係なく同じです。共同作業中のコードベースに貼り付ける予定なら、そのプロジェクトが使っている幅に合わせればよく、API リクエスト本文のように空白が重要でない場所では 1 行(圧縮)オプションのほうが便利です。
この記事は韓国語の原文をもとに作成しています。 韓国語の原文を読む