Talend API Testerを使ってみる - EatSmartシステム部ブログ

今回は、API開発やテストなどに使える便利なツールTalend API Testerをご紹介します。
※最近、プロダクト名の変更があったようなので調べる際には、Talend API Testerに変えて Restlet Clientでも情報が多くヒットします。

Talend API Testerについて

詳細については、以下に譲りますがブラウザベースで、APIの結果を確認できるChromeの拡張機能です。基本的には、リクエストしたURLに対するAPIの返却結果の確認や渡すパラメーターの正当性を確認するテストなどに使えるかと思います。 Talend API Tester概要

ツールの導入に関して

https://chrome.google.com/webstore/detail/talend-api-tester-free-ed/aejoelaoggembcahagimdiliamlcdmfm/reviews?hl=ja&utm_source
上記サイトから、Googleアカウントにログイン状態で「Chromeに追加」を選択し、「拡張機能を追加」で TalendAPI Tester(無償版)が利用できるようになります。 f:id:eatsmart:20191206150214p:plain
Chromeのメニューバーからアプリの利用ができます。

POSTメソッドを試す

弊社で提供しているサービスカロリーチェックAPIを用いて、まずはPOSTでのリクエストで、食品に関するカロリーデータを取得してみます。 APIの仕様上、まずは認証キーを取得する必要があるため、POSTメソッドで認証キーを取りに行きます。画面に「METHOD」と書かれたタブをPOSTにし、URL入力覧にリクエストするためのURLを入れます。パラメーターとして、siteId(コンテンツ利用に必要なID)とpasswordが必要になるため、「QUERY PARAMETERS」の欄で参考画像のようにパラメータをセットします。 f:id:eatsmart:20191206150908p:plain

セット完了後、「send」を押すとレスポンスが確認ができます。 f:id:eatsmart:20191206151044p:plain

authkeyが取得できているのが確認できます。また、ステータス0は「正常」を指すので正しくリクエストしていることになります。

GETメソッドを試す

前項で得られたauthKeyを利用し、六花亭のマルセイバターサンドの食品データを取得していきます。次は、GETメソッドでリクエストするので、「METHOD」をGETにします。例にならって、「QUERY PARAMETERS」でパラメーターをセットします。authKeyに加えて、今度は食品に割り当てられたfoodCodeも追加し、リクエストを送信します。
f:id:eatsmart:20191206151322p:plain

200OKとともに、食品名、カテゴリー名、店舗名などが返却されているのが確認できます。
f:id:eatsmart:20191206153834p:plain

また、フリーワードでAPIに対してリクエストした場合、freeword(ピスタチオで検索)に加えて、offset,limitをパラメーターで渡すことで以下のような結果が確認できます。 f:id:eatsmart:20191206155935p:plain

　その他便利な機能

よく使うリクエストを保存して、次回使う際に呼び出すことができるSave機能があります。右上の「Save as」を選択し、プロジェクト(例：カロリーチェック)を作成し、そのプロジェクト内に使用したリクエストを保存しておくだけです。左のメニューにプロジェクト及びリクエスト名が確認できるので、そちらからデフォルトでURL、パラメーターが予め設定されたものが利用できるようになります。 f:id:eatsmart:20191206152006p:plain 返却結果をCSVファイルとしてエクスポートすることもできます。

まとめ

以上となりますが、ブラウザからAPIをたたき、テスト結果を簡単に確認できるので、IDEなどを立ち上げる必要がない分、便利に感じると思います。特定の開発環境を構築する必要もないので、例えばAPIの返却結果を他人と共有して見たいなど開発に限定しないシーンでも広く使えるのではないでしょうか。