Windowsでjqコマンドを導入してJSONレスポンスを整形・抽出する

jqコマンドはいいぞ

Macのcurlで愛用しているjqコマンドをWindowsでも使いたかったのでインストールしました。
https://stedolan.github.io/jq/

普通にcurlコマンドを叩いた場合、JSONレスポンスは1行表示で出力されます。また、日本語文字列はエスケープされて内容がよくわかりません。

$ curl "http://geoapi.heartrails.com/api/json?method=searchByPostal&postal=1620067"
{"response":{"location":[{"city":"\u65b0\u5bbf\u533a","city_kana":"\u3057\u3093\u3058\u3085\u304f\u304f","town":"\u5bcc\u4e45\u753a","town_kana":"\u3068\u307f\u3072\u3055\u3061\u3087\u3046","x":"139.716002","y":"35.693258","prefecture":"\u6771\u4eac\u90fd","postal":"1620067"}]}}

jqコマンドを導入すると、レスポンスの出力が整形されて見やすくなったり、フィルタ機能で必要な情報だけを抽出できるようになります。

$ curl 'https://api.github.com/repos/stedolan/jq/commits?per_page=5'
[
  {
    "sha": "d25341478381063d1c76e81b3a52e0592a7c997f",
    "commit": {
      "author": {
        "name": "Stephen Dolan",
        "email": "[e-mail]",
        "date": "2013-06-22T16:30:59Z"
      },
      "committer": {
        "name": "Stephen Dolan",
        "email": "[e-mail]",
        "date": "2013-06-22T16:30:59Z"
      },
      "message": "Merge pull request #162 from stedolan/utf8-fixes\n\nUtf8 fixes. Closes #161",
      "tree": {
        "sha": "6ab697a8dfb5a96e124666bf6d6213822599fb40",
        "url": "https://api.github.com/repos/stedolan/jq/git/trees/6ab697a8dfb5a96e124666bf6d6213822599fb40"
      },
      "url": "https://api.github.com/repos/stedolan/jq/git/commits/d25341478381063d1c76e81b3a52e0592a7c997f",
      "comment_count": 0
    },
    "url": "https://api.github.com/repos/stedolan/jq/commits/d25341478381063d1c76e81b3a52e0592a7c997f",
    "html_url": "https://github.com/stedolan/jq/commit/d25341478381063d1c76e81b3a52e0592a7c997f",
    "comments_url": "https://api.github.com/repos/stedolan/jq/commits/d25341478381063d1c76e81b3a52e0592a7c997f/comments",
    "author": {
      "login": "stedolan",
...

超絶便利。

jqコマンドの導入方法

さっそく導入していきます。

exeのダウンロード

公式サイトへアクセスし、Windows用のexeをダウンロードします。

ダウンロードしたexeファイルの名前をjq-win64.exeからjq.exeにリネームしておくと、コマンド呼び出しが楽になるので変更しておきます。

環境変数のpathを通す

pathを通すフォルダにexeファイルを移動。ここではユーザーフォルダ直下に移動します。

例）C:\Users\unsol\jq.exe

ユーザー環境変数のPathを選択して「編集」をクリック。

「新規」で先ほどexeファイルを置いたユーザーフォルダ（ここではC:\Users\unsol）を追加。

「OK」を押して閉じます。

場合によっては再起動が必要となります

コマンドの実行確認

コマンドプロンプトやbashターミナル等を開いてjqコマンドが使えるようになったか確認します。以下コマンドを叩いて、導入したjqのバージョンが表示されればOKです。

$ jq -V
jq-1.6

ヘルプでコマンドオプション等の詳細を参照できます。

$ jq --help
jq - commandline JSON processor [version 1.6]

Usage:  C:\Users\unsol\jq.exe [options] <jq filter> [file...]
        C:\Users\unsol\jq.exe [options] --args <jq filter> [strings...]
        C:\Users\unsol\jq.exe [options] --jsonargs <jq filter> [JSON_TEXTS...]

jq is a tool for processing JSON inputs, applying the given filter to
its JSON text inputs and producing the filter's results as JSON on
standard output.

The simplest filter is ., which copies jq's input to its output
unmodified (except for formatting, but note that IEEE754 is used
for number representation internally, with all that that implies).

For more advanced filters see the jq(1) manpage ("man jq")
and/or https://stedolan.github.io/jq

Example:

        $ echo '{"foo": 0}' | jq .
        {
                "foo": 0
        }

Some of the options include:
  -c               compact instead of pretty-printed output;
  -n               use `null` as the single input value;
  -e               set the exit status code based on the output;
  -s               read (slurp) all inputs into an array; apply filter to it;
  -r               output raw strings, not JSON texts;
  -R               read raw strings, not JSON texts;
  -C               colorize JSON;
  -M               monochrome (don't colorize JSON);
  -S               sort keys of objects on output;
  --tab            use tabs for indentation;
  --arg a v        set variable $a to value <v>;
  --argjson a v    set variable $a to JSON value <v>;
  --slurpfile a f  set variable $a to an array of JSON texts read from <f>;
  --rawfile a f    set variable $a to a string consisting of the contents of <f>;
  --args           remaining arguments are string arguments, not files;
  --jsonargs       remaining arguments are JSON arguments, not files;
  --               terminates argument processing;

Named arguments are also available as $ARGS.named[], while
positional arguments are available as $ARGS.positional[].

See the manpage for more options.

使用例

curlコマンドにjqをパイプで繋げるだけで、レスポンスが整形されて出力されます。冒頭でエスケープされてよくわからなかった日本語部分も、普通に読める形で出力されるようになりました。

$ curl -s "http://geoapi.heartrails.com/api/json?method=searchByPostal&postal=1620067" | jq
{
  "response": {
    "location": [
      {
        "city": "新宿区",
        "city_kana": "しんじゅくく",
        "town": "富久町",
        "town_kana": "とみひさちょう",
        "x": "139.716002",
        "y": "35.693258",
        "prefecture": "東京都",
        "postal": "1620067"
      }
    ]
  }
}

フィルタを使えば、JSONから必要な情報だけをサクッと取得することもできます。

$ curl -s "http://geoapi.heartrails.com/api/json?method=searchByPostal&postal=1620067" | jq '.response.location[] | [.prefecture, .town, .city]'
[
  "東京都",
  "富久町",
  "新宿区"
]

階層のインデックス指定やソートなど、より高度にjqコマンドを使いこなしたい方は公式マニュアルをご参照ください。

jq Manual (development version)