Blog

JSONを整形し、調べたい値のJSON Pointerをコピーする

一行のAPIレスポンスをブラウザで整形し、ツリー表示から調べたい値のJSON Pointerをコピーする。スクリーンショットとサンプルで、圧縮や構文チェックの操作も紹介する。

英語版ツールで一行のJSONとインデント付きの整形結果を左右に並べた画面

APIのレスポンスが一行で返ってきたとき、値を読むだけなら改行を入れると見やすい。調査メモで「2件目の在庫が0」と伝えたいときは、その値を指すパスも添えると、同じレスポンスを見た人が場所をたどれる。JSON整形・圧縮・検証ツールで、架空の商品一覧を例に両方の操作を試す。貼り付けたデータの処理はブラウザ内で完結する。

一行のレスポンスを読みやすくする

「入力JSON」に次のサンプルを貼り付ける。

{"items":[{"sku":"A-001","stock":12},{"sku":"B-002","stock":0}]}
  1. 「インデント」を 2 にして「Pretty →」を押す。
  2. 「出力」で items 配列の2件目を探す。sku が B-002 の項目では stock が 0 になっている。
  3. 整形結果をファイルに残す場合は「Copy」を押し、エディターに貼り付けて保存する。一行に詰めた形式が必要なら「Minify →」を押してからコピーする。
英語版のInput JSON欄に商品一覧を貼り付け、Output欄に空白2つで整形した結果を表示した画面
入力と出力は別々の欄に表示されるので、元の一行と整形後の階層を見比べられる。

ツリーから2件目の在庫のパスを取る

  1. 同じ入力で「ツリー表示」(英語版では「Tree view」)を押す。
  2. items を開き、[1] を展開して "stock": 0 を選ぶ。配列は0から数えるので、[1] が2件目である。
  3. 「選択中の JSON Pointer」に /items/1/stock と出ることを確認し、「パスをコピー」(英語版では「Copy path」)を押す。調査メモには、どのレスポンスを調べたかとあわせて記録する。
ツリーでitemsの2件目を開き、選択したstockのパスとして/items/1/stockが表示された英語版の画面
パスの欄には選んだ値の位置が表示される。この例の値そのものは0である。

JSON Pointer では、キーに含まれる / は ~1、~ は ~0 と表す。たとえば stock/on-hand という一つのキーは stock~1on-hand となる。RFC 6901の構文 に定義されている。

整形できないときは構文を確認する

たとえば2件目を {"sku":"B-002","stock":0,} と書くと、閉じ波括弧の直前にある末尾カンマがエラーになる。「Validate」を押すと構文を確認でき、ブラウザから位置情報を取得できる場合は行と列が表示される。カンマを消し、もう一度「Validate」を押してから整形する。

「Validate」で確認できるのはJSONの構文である。stock が必須か、値が負数でもよいかといったAPI固有の条件は、APIの仕様やスキーマで確認する。