協力会社さんのバックエンドエンジニアの方がこちらのツールを使っており、調べてみたところ予想外に便利だったので記事を書きます。
Chromeの拡張機能Talend API Testerは、HTTPやREST APIの動作確認が簡単に行えます。
他のAPIテストツールとして、(自分が知る限りでは) Postmanなどが有名かと思うのですが、
①環境変数をglobalに設定でき、変更が容易。ログイン毎に値が変わるような変数も手間なく取り扱える。
②一人の環境で作ったエンドポイントやクエリパラメータ等の情報を、JSON化して簡単に他のメンバーの環境へインポート可能(しかも、swaggerやPostmanでの環境も簡単に再現可能！)
という点で、より便利なクライアントツールかと思っております。
これから当ツールの扱い方を解説するのですが、その中で上記①②の再現方法も言及します。
基本的な使い方
(1) 環境変数を設定する
画面右上のここで、BASE_URLやaccess-tokenといった環境変数を、キーバリュー形式で保存可能です。
ローカル/ステージング/本番環境でホスト名が違ったりするときには、ここでBASE_URLのvalueの値を書き換えれば都度切り替えられます。
他にも、ログインする度に値が変わる要素(access-tokenや、user_idなど)についても、ここで値を書き換えることで完結できます。
ここで設定した変数は、(2)の箇所で${BASE_URI}といった形式で呼び出せます。
(※)ここの記事では"QiitaEnv"という名前で環境を作っておりますが、もちろん環境は複数個作れます
(2) リクエストを作成する
下記の画像を見ていただければ、おおよその概要は把握いただけるかと思います。
(一) METHODをGET/POST/PUT/DELETEから選択
(二) SCHEME(URL)を書く
(三) (必要があれば)QUERY PARMETERを設定
(四) (必要があれば)HEADER情報を記載(※)(1)で設定した環境変数を呼び出し
こちらで送信して問題がなければ、"Save"ボタンを押して保存することで、次回以降も同じリクエストをそのまま飛ばせます。
環境のIMPORT/EXPORT
自分のローカルで作った環境を、JSON形式にして容易に他の人のローカルでも再現可能です。
(一) 画面右下の"Export"ボタンを選択
(二)
自分のローカル環境を、プロジェクト単位(ここではsample1, sample2)で選択しJSON化してダウンロードできます。
(三)
他のメンバーのローカルで"IMPORT"ボタンを選択 → "Import API Tester repository"を選択し、(二)で作成されたJSONをIMPORTすることで、一瞬で環境を再現できます。
(自分は使ったことがありませんが、ここでswaggerやPOSTMANのデータをインポートする事も出来るようです)
まとめ
今まで、APIのテストをするときは逐一webアプリからAPIを呼び出したり、ターミナルでベタ打ちでテストしていたのですが、このツールを知ったから効率が飛躍的に向上しました。
エンジニアとして実務経験1年半ほどになりますが、まだまだ自分の知らない事だらけです…
自分が今、普段の業務の中で膨大な時間をかけている作業の中にも、圧倒的に時間を削減できるものがまだまだあるんだろうなあと思います。もっと勉強せねば…