データ
JSON5とは
JSON5はJSONを拡張し、コメント、末尾カンマ、引用符を省いた一部のキー、シングルクォート文字列などを許すデータ形式です。人が手で書く設定向けで、JSONの単純な別名ではありません。受け手がJSON5を解析できるかを確認します。
.json5構造化データ
この形式を選ぶ場面
- JSONに近い構文を読み書きしやすくしたい
- JSON5対応パーサーが確定しているアプリ設定
避けた方がよい場面
- 標準JSONのみを受け付けるAPIや交換データ
- JSON5対応を確認できないツール間の連携
主な用途
- 手作業で編集する設定ファイル
- コメントを残した構造化データ
特徴
- JSONに似たオブジェクト・配列の構造
- コメントと末尾カンマを記述できる
- 一重引用符や一部の引用符なしキーを使える
メリットとデメリット
メリット
- 手作業で編集する設定にコメントを残せる
- JSONに近い構造で読み書きしやすい
デメリット
- 標準JSONパーサーでは読めない構文を含む
- JSON5対応ライブラリやツールが必要
開く・変換する
開く方法
JSON5対応エディタやパーサーで開きます。標準JSONパーサーへそのまま渡すと、コメントや末尾カンマなどで解析に失敗する場合があります。
変換方法
標準JSONへ変換するとコメントや書式上の自由度は失われます。変換後のJSONを対象アプリやAPIで検証し、設定値が意図どおりか確認します。
注意点
- JSON5仕様は機械間のデータ交換ではなく、人が書くデータを想定しています。相手側のJSON5対応を確認してください。
- 拡張子を.jsonへ変えるだけでは標準JSONに変換されません。
FAQ
JSON5はJSONと互換性がありますか？
有効なJSON文書はJSON5としても有効ですが、JSON5独自のコメントや末尾カンマなどは標準JSONでは使えません。