外部APIを利用したいとき、レスポンスの中身を手軽に見てみたい、と思うときがあるかと思います。
そんなときに、Postmanは、ベースとなるURLやKeyをGUI上で指定してAPI呼び出し結果を得ることができるサービスです。
Postmanへの登録
Postman API Platform
Webアプリ版とクライアントアプリ版があるようですが、今回はWebアプリ版で試してみました。
なお、ユーザ登録が必要と思い、登録はしましたが、Team機能を利用しない場合は登録しなくとも使えるようです。
一時的にAPIをテストしたい時は、普通にURLを文字列で書き起こした方が早い場合もあるので、自分のAPIテストが再利用できる利点を生かすためにもユーザ登録はした方がPostmanを使う意味があるのかなと思います。
YahooデベロッパーネットワークのAPIで試してみる
さて、サンプルとして、日本のYahooAPIで形態素解析を試してみました。
なお、API仕様や画面は今後変更や廃止となる場合がありますのでご注意下さい。（本記事は2022年1月時点のものです。）
APIドキュメント – Yahoo!デベロッパーネットワーク
テスト用開発アプリケーションの登録
Yahoo IDが必要になるので、持っていない方は、YahooIDを登録して下さい。
また、今回は例としてYahoo APIを使っているだけなので、他のAPIを使う場合、読み流すだけで大丈夫です。
右上にある「アプリケーションの管理」の赤いボタンから、新たに作るアプリケーションを登録します。
画面の中央あたりにある「新しいアプリケーションを開発」ボタンを押します。
今回は、外部サービスを使った初期的なテストなので、「クライアントサイド」を選択しました。
自分で管理できるサーバからのアクセスであれば「サーバサイド」が良いのでしょう。
Postmanからも秘密鍵を配備してアクセスできるのかもしれませんが、呼び出し元URLが固定されてしまうので、今回のように、返り値を見るためだけのテストには不向きだと思ったのもあり、「クライアントサイド」にしています。
画面の指示に従って登録を進めていくと、Client IDが表示されますので、それをテキストエディタなどにコピーしておきます。
Yahoo Japanのデベロッパーネットワークの公開APIサイトから「テキスト解析」→「日本語形態素解析」と進みます。
日本語形態素解析のリクエストパラメータ
リクエストURLとリクエストパラメータが示されます。
リクエストURL
https://jlp.yahooapis.jp/MAService/V1/parse
リクエストパラメータ（必須項目のみ）
| パラメータ | 値 |
|---|---|
| appid | string |
| sentence | string |
| results | string: ma, uniq 解析結果の種類をコンマで区切って指定します。 “ma”: 形態素解析の結果を ma_result に返します。 “uniq”: 出現頻度情報を uniq_result に返します。 無指定の場合は “ma” になります。 |
必須項目以外にもパラメータはいろいろありますが、必要に応じて設定するとして、今回はパスします。
Postman側でのリクエストURLの生成
ワークスペースの作成
Workspaces→Myworkspace→「New」もしくは「＋」で、新しいWorkspace作成。
「HTTP Request」を選択。
APIコールするURLを生成します。ベースURLと各パラメータを入力していくと、URLが生成されていきます。
GETの欄には、形態素解析のリクエストURL「 https://jlp.yahooapis.jp/MAService/V1/parse 」を記入。
KEYとVALUEの欄はクリックすると、値が入力できますので、下記の通り入力します。
1行目のKEYには、「appid」、VALUEには、先ほどYahooデベロッパーネットワークで取得したClient IDを入力。
2行目のKEYは「sentence」、VALUEには解析したい日本語。
3行目のKEYは「results」、VALUEには「uniq」としておきます。
そして、右上の青い「Send」ボタンを押すと、ウインドウの下部に以下のような結果が出てきます。
もし、エラーメッセージ的な内容が表示されたら、Client IDの入力ミスやURL記載ミスなどが考えられますので、確認して下さい。
結果がxmlで返ってきました。
後は、APIの値を利用したそれを受け取るアプリを自分で書くことができます。
他のAPIでもKEYとVALUEを渡すだけなので、同様のAPI呼び出しが可能ですね。
おわりに
こうした返り値の結果は、APIドキュメントにサンプルとして載っていますが、自分の手を動かして結果を得てみることで、内容の理解が深まります。
また、テキストでURL生成しようとすると、その事前準備がいろいろと必要だったりしますが、このPostmanはWebサービスとして提供されているので、APIの動作をさっと試すことができます。