整形(インデント)と圧縮(1行)
APIのレスポンスやログに出力されたJSONは、改行のない1行の文字列になっていることがよくあります。貼り付けるだけで、階層ごとにインデントされた読みやすい形に変換します。インデントはスペース2つ・4つ・タブから選べます。
反対に「圧縮(1行)」を選ぶと、改行や空白を取り除いて1行にまとめます。設定ファイルに埋め込むときや、通信量を減らしたいときに使います。「キーをアルファベット順に並べ替え」にチェックを入れると、項目の順番を揃えられるので、2つのJSONを比べるときに便利です。並べ替えた後にテキスト比較に貼り付ければ、中身の違いだけを確認できます。
構文エラーの場所と原因
JSONとして正しくない場合は、エラーが起きた行と文字の位置に「^」の印を付けて表示します。よくある原因は次のとおりです。
| 原因 | 誤り | 正しい書き方 |
|---|---|---|
| 最後の要素の後ろにカンマ | {"a": 1,} | {"a": 1} |
| シングルクォート | {'a': 'b'} | {"a": "b"} |
| キーをクォートで囲んでいない | {a: 1} | {"a": 1} |
| コメントを書いている | {"a": 1 // メモ} | コメントは書けない |
| 要素の間のカンマ抜け | [1 2] | [1, 2] |
| undefined や NaN | {"a": undefined} | {"a": null} |
エラーの原因と直し方はJSONの構文エラーでよくある原因7つと直し方で詳しく解説しています。
JSONとは(構文のルール)
JSON(JavaScript Object Notation)は、データをやり取りするための文字列の形式です。JavaScriptのオブジェクトの書き方をもとにしていますが、ルールはより厳しく決められています。
- オブジェクトは
{ }、配列は[ ]で囲む - キー(項目名)は必ずダブルクォート(")で囲む
- 値に使えるのは、文字列・数値・true・false・null・オブジェクト・配列の7種類
- 文字列はダブルクォートで囲み、改行は
\nのように書く - コメントや最後の余分なカンマは使えない
VS Code・jqでの整形との比較
| 方法 | 操作 |
|---|---|
| VS Code | Shift+Alt+F(Macは Shift+Option+F)で「ドキュメントのフォーマット」 |
| jq(コマンドライン) | cat data.json | jq .(圧縮は jq -c .) |
| Python | python -m json.tool data.json |
| このツール | 貼り付けるだけ。インストール不要で、エラー箇所の説明つき |
APIのデータにBase64で埋め込まれた値が含まれている場合はBase64変換で、URLに含まれるパラメータはURLエンコード・デコードで中身を確認できます。