JSON YAMLの違い|インデント規則とよくある失敗

公開ツールJSON ↔ YAML 変換

目次
  1. JSONは括弧で、YAMLは改行で境界を示します
  2. YAMLが設定ファイルで選ばれることが多いのはなぜか
  3. その「便利さ」がよくあるミスの原因になる理由
  4. このツールが境界のルールを代わりに処理する仕組み
  5. 逆方向(YAML → JSON)でも同じ境界が基準になります
  6. まとめ
  7. よくある質問

設定ファイルを開いてみると、あるファイルには中括弧やダブルクォート、カンマがびっしりと並び、別のファイルには句読点がなく改行とインデントだけで構造が見えていることがあります。前者がJSON、後者がYAMLです。どちらも同じデータを表現できるのに、句読点の量がここまで違うのには理由があります。

この違いは好みの問題ではなく、データの「境界」(どこで値が終わり、どこから次の値が始まるのか)を示す仕組みそのものが異なるからです。そしてこの設計の違いが、YAMLが設定ファイルで好まれる理由であると同時に、YAMLファイルがやたらと壊れやすい理由でもあります。

まとめ ① JSONは中括弧・角括弧・カンマ・クォートでデータの境界を示し、YAMLは改行とインデントの桁数で境界を示します。 ② 句読点を最小限にしたおかげで、YAMLは人が読み書きしやすく、設定ファイル(config)で広く採用されています。 ③ 同じ理由で、インデントのスペース数が1つずれたりタブ文字が混ざったりすると、YAMLファイル全体の構造が壊れます。

JSONは括弧で、YAMLは改行で境界を示します

JSONではオブジェクトが中括弧で始まり中括弧で終わり、その中の各項目はカンマで区切られます。文字列の値は必ずダブルクォートで囲む必要があり、キーも同じです。これらの句読点があってこそ、パーサーは「ここまでが1つの値」という境界を正確に知ることができます。

YAMLはこれらの句読点を、改行とインデントで置き換えます。同じインデント幅を持つ行は同じ階層に属し、より深くインデントされた行は直前の行の子項目になります。中括弧もカンマもなく、空白の数だけで階層構造を表現する方式です。

YAMLが設定ファイルで選ばれることが多いのはなぜか

設定ファイルは、人が直接開いて値を1つ書き換えることが多いファイルです。こうした用途では、中括弧やカンマが行ごとに繰り返されるJSONよりも、インデントだけで構造が一目で見えるYAMLのほうが、ざっと目を通すときにずっと楽です。

特に値が多く階層が深くなるほど、この差は広がります。JSONは閉じ括弧の位置を合わせることにも気を配る必要がありますが、YAMLはインデントの深ささえ合わせれば、項目の追加や順序の入れ替えが比較的容易です。そのため、人が頻繁に手で編集する設定ファイルではYAMLが好まれる傾向があります。

その「便利さ」がよくあるミスの原因になる理由

ところが、この便利さの根拠だったまさにその点、つまり「空白の数で構造を表現する」という特徴が、YAMLで最もよくあるエラーの原因でもあります。JSONは括弧とカンマが明示的なので、インデントが揃っていなくてもパース自体は通ります。YAMLはインデントそのものが文法なので、空白数が1つずれただけでも別の階層として解釈されたり、そもそもエラーになったりします。

タブ文字も同じです。YAMLの仕様では、インデントにタブ文字を使うことは認められていません。エディターによってタブを画面上で何桁として表示するかが異なるため、タブ1つがスペース何個分と同じインデントなのかをパーサーが決められないからです。スペースだけでインデントした行とタブが混ざった行が、見た目には同じように整列していても、パーサーはこの2つを別のインデントとして扱います。

JSON ↔ YAML 変換

JSONとYAMLを双方向にすぐ変換し、インデントや引用符の規則を自動で整えてくれる「JSON ↔ YAML 変換」

このツールが境界のルールを代わりに処理する仕組み

JSON YAML 変換は「JSON → YAML」タブの入力欄にJSONを貼り付けると、先ほど説明した境界のルールを自動で適用し、インデントベースのYAMLに変換して表示します。インデントの桁数を手で合わせたり、タブとスペースを区別したりする必要はありません。

この変換で興味深いのは、どの文字列にクォートを残し、どの文字列はクォートを外すかという点です。文字列の値がtrue・false・null・yes・noのような予約語に見えたり、数値に見えたりする場合、クォートなしのままにするとYAMLパーサーが真偽値や数値と誤認する可能性があります。このツールはそうしたケースや、コロン・角括弧などの特殊文字が含まれるケースではダブルクォートを残し、それ以外の普通の文字列はクォートなしで出力して、YAMLならではの簡潔さを活かします。

逆方向(YAML → JSON)でも同じ境界が基準になります

「YAML → JSON」タブに切り替えると、逆の作業も確認できます。インデントで表現されたYAMLを入力欄に入れると、ツールが各行のインデント幅を読み取り、階層を中括弧・角括弧・カンマの形に展開して表示します。

この方向で特に役立つのは、インデントが実際に何桁ずれているのかを目で数えなくて済むという点です。人には似て見えるインデントでも、ツールが階層を別物として読み取っていれば、結果として出たJSON構造を見て、どの行のインデントが意図と違って処理されたのかをすぐに確認できます。

まとめ

  • JSONは中括弧・角括弧・カンマ・クォートで、YAMLは改行とインデントの桁数でデータの境界を示します。
  • インデントベースの文法は人が読み書きしやすい一方、同じ理由で空白数が1つずれただけでも構造が壊れる弱点があります。
  • YAMLは仕様上、インデントにタブ文字を認めておらず、タブとスペースが混ざるとパーサーが階層を別物として解釈します。
  • 文字列の値が予約語や数値に見える場合にだけクォートが必要で、それ以外はクォートなしで表現するのがYAMLのやり方です。
  • 2つの形式を行き来しながら構造が正しく変換されているか確認したいなら、自分で変換ツールに入れてみるほうが、目で空白を数えるより正確です。
JSON ↔ YAML 変換

JSONとYAMLを双方向にすぐ変換し、インデントや引用符の規則を自動で整えてくれる「JSON ↔ YAML 変換」

よくある質問

YAMLでタブ文字を使うとエラーになるのはなぜですか?

YAMLの仕様では、インデントに使えるのはスペースだけで、タブ文字は認められていません。エディターによってタブ1つを画面上で何桁として表示するかが異なるため、タブがスペース何個分のインデントに当たるのかをパーサーが一貫して決められないからです。画面上では整列して見えても、ファイルの中にタブが混ざっていればパースの段階でエラーになることがあります。

JSONではなぜいつもクォートを付けなければならないのですか?

JSONはインデントではなく、中括弧・角括弧・カンマといった句読点で値の境界を示す形式です。文字列の前後にクォートがないと、パーサーはその値がどこで終わるのか、次に来るカンマやコロンが文字列の一部なのか文法記号なのかを区別できません。そのため、文字列の値とキーは例外なくダブルクォートで囲む必要があります。

YAMLではインデントの桁数を必ず揃えないといけないのですか?

はい、同じ階層に属する項目は必ず同じインデント幅でなければなりません。1つの項目だけ桁数が違うと、その項目が別の階層へ移されたように解釈されたり、パーサーが構造をまったく読めずにエラーを出す場合があります。見た目が似た整列でも、実際の桁数が違えば結果も変わってしまいます。

JSONをYAMLに変換すると必ず短くなりますか?

必ずしもそうとは限りません。値がいくつかしかない単純な構造では、2つの形式で行数の差が大きくならないことがあります。ただ、階層が深く項目が多い設定データほど、中括弧やカンマ・クォートを繰り返し書かなければならないJSONよりも、インデントだけで構造を表現するYAMLのほうが、おおむね短く読みやすい形になります。

この記事は韓国語の原文をもとに作成しています。 韓国語の原文を読む

関連記事

  1. Markdownの改行が反映されない原因と3つの対処法MarkdownでEnterを1回押しても改行が消えて文がつながる理由を、CommonMarkの仕様から説明します。空行・行末の空白2つ・breaksオプションの3つの方法で確実に改行する方法も解説します。
  2. マークダウン表の中央揃えは区切り線のコロンで決まるマークダウン表の中央・右揃えが、セル内の空白ではなくヘッダー下の区切り線のコロン位置で決まる仕組みを解説します。表が崩れる原因と正しい書き方もわかります。
  3. マークダウン表をExcelで開けるCSVに変換する方法NotionやGitHubのマークダウン表をExcelに貼り付けると崩れる理由と、区切り線やエスケープされたパイプまで整理してCSVへ正確に変換する方法を説明します。
  4. 議事録の書き方|議題・決定事項・アクションアイテムの残し方議題だけの議事録は後で使えません。議題・決定事項・アクションアイテムを分け、担当者と期限を添える書き方と、自動で整えるツールの使い方をまとめました。
  5. プレスリリース 5W1Hの書き方|タイトルとリード文の順序プレスリリースのタイトルと最初の段落に、5W1Hをどの順番で置けば記者に読まれるかを解説。よくある失敗と、事実だけで書くためのコツが分かります。
  6. 提案書の目次構成|事業タイプ別の標準順序提案書の目次が自由に決められない理由と、IT構築・マーケティング・提携・公共入札の4タイプ別の標準構成、発注元が目次を指定した場合の優先順位をまとめました。

関連ツール