JSONクエリ
JSONPathを使ってJSONデータから必要な値だけを抽出します。
使用例
大きなAPIレスポンスから必要なフィールドだけ取り出す
レスポンスのJSON全体を探さなくても、$.data.items[*].idのようなパスで必要な値だけを一度に取り出せます。
条件に合う項目だけ絞り込む
$.products[?(@.price<10000)]のようなフィルター式を使えば、価格や在庫などの条件に合う項目だけを抽出できます。
入れ子構造の中から特定のキーを一度に探す
再帰探索構文の$..priceを使うと、深さや位置に関係なく文書全体から同じ名前のキーをすべて見つけられます。
配列の最後の項目だけ取り出す
増え続けるログや注文の配列から最新の1件だけを取り出したいときは、要素数を数えなくても$.orders[-1:]で簡単に取得できます。
必要なフィールドだけまとめて抜き出す
$.user['name','email','id']のような複合式を使えば、大きなユーザーレコードの中からその3つのフィールドだけをまとめて取得し、他を無視できます。
初めて見るAPIレスポンスの構造を把握する
見たことのないレスポンスでフィールドがどのくらいの深さにあるかわからない場合は、まず$..フィールド名でどこにあっても探し出し、見つかったら正確なパスに絞り込んでいきましょう。
よくある質問
入力したJSONと式はサーバーに送信されますか?
いいえ。クエリはブラウザ内でのみ実行され、入力した内容がサーバーに送信されることはありません。
JSONPathの文法を覚えていません。
よく使うパターンはこちらです: $は文書全体、.keyは特定のキー、[*]は配列のすべての項目、[0]は最初の項目、[?(@.price<10)]は条件に合う項目だけを絞り込み、$..keyは深さに関係なくその名前のキーをすべて見つけます。
結果が空です。なぜですか?
パスが指すデータが実際に存在しない場合も、式の文法が間違っている場合も、どちらも空の結果になります。パスを一段階ずつ短くして、どこで一致しなくなるか確認してみてください。
クエリ結果は常に配列ですか?
はい。JSONPathは一致したすべての値を配列にまとめて返します。一致する値が1つだけでも、長さ1の配列として出力されます。
これはJSONPathですか、それともJMESPathやjqの構文ですか?
JSONPathで、jsonpath-plusライブラリを使って評価しています。標準的な$、.、[*]、[n]、$..keyの構文に加え、フィルター式([?(@.price<10)])などの拡張機能にも対応していますが、jqやJMESPathのクエリ構文とは互換性がなく、それらは別の演算子を使います。
配列を複数条件で絞り込むことはできますか?
できます。フィルター式の中で&&や||を使って条件を組み合わせれば、たとえば$.products[?(@.price<100 && @.inStock==true)]のように、安くて在庫もある商品だけを一致させられます。
パスの中で負のインデックスやスライス表記は使えますか?
使えます。[-1]は最後の要素を指し、[1:3]や[-2:]のようなスライス構文もPythonと同じように動作するため、配列の正確な長さを知らなくても範囲を取り出せます。