Chrome の拡張機能 Talend API Tester で API のテストを行う方法

ウェブの技術を使ったシステム開発の現場では全てをゼロからプログラムするのではなく API と呼ばれる機能を取り入れて開発することがあり、API の動作確認を簡単にするツールとして Chrome の拡張機能で提供されている Talend API Tester の使い方を紹介する。

１．API とは

API とは Application Programming Interface の略で、決まったデータを渡すと API の動作仕様に基づいて処理や決まった形式でデータを返す機能のことである。

例えば顧客情報を蓄積しているデータベースより○○という名前の企業名の情報を取得したい場合、ゼロからプログラムすると次のような処理が必要になる。

1. データベースに接続する
2. ○○を取得する SQL を用意する
3. SQL をデータベースに対して実行する
4. データベースから返ってきた○○のデータを成型する

データベースから 1 つのデータを取得するだけでもプログラムで用意するとこのように少なくとも 4 つの工程を経て、求めるデータを入手することができる。

ここで「企業名を渡すと企業情報を返す API」が既にあると、開発者は次の 1 つの工程のみプログラムすると求めるデータが得られる。

1. ○○のデータを付けて API にリクエスト（処理の依頼）する

２．API が便利な理由

API が便利な理由としては、前述の通りゼロから機能をプログラムせずとも、用意されている API を利用して開発を楽にすることができる。
開発が楽になると開発工数が抑えられるので短納期、低コストでのシステム開発も可能になる。

また、外部のサービスで API が提供されていることもある。
例えば SNS の Twitter であれば API にツイートしたい文章をリクエスト（処理の依頼）すると指定するアカウントのタイムラインにツイートが投稿される。
LINE であれば友達全員にプッシュ通知することもでき、外部サービスとの連携により利便性が高いシステムやサービスを構築することができる。

３．API を使う方法

API を使う方法としては、インターネットを利用したウェブ系であれば HTTP または HTTPS 通信を利用し、主に GET と POST と呼ばれる 2 つの形式で行う。

GET は API がある URL の後ろにそのまま渡したいデータを付与して送るだけで API が実行される。
そのため、ブラウザの URL に API の URL と渡したいデータを入力してアクセスするだけでも API が利用できる。
下記は GET でリクエストする際の例で、上側は URL の後ろに ? を挟んでデータを付けており、name というパラメータに○○という値を付けていることを指す。

https://{API のパス}/?name=○○
https://{API のパス}/○○/

下側は上側と違い ? と name も付けずに渡したい値だけを付与する形である。
利用する API により渡し方が異なるので API のマニュアルに沿って利用する。

また、POST でリクエストする際の例が下記となり、API の URL と渡すデータ部が分かれている。
GET と違い POST の場合はブラウザの URL 欄からリクエストすることができず、POST 用のプログラムを用意するか後述する API にリクエストする Chrome の拡張機能である Talend API Tester を利用する。

POST https://{API のパス} HTTP/1.1
content-type: application/json

{
“name”:”○○”
}

４．Talend API Tester とは

Talend API Tester とは、API に対して GET や POST のリクエストと API から返ってきたデータを目視できる Google が開発提供するブラウザ Chrome の拡張機能である。

Talend API Tester は有償版と無償版があり、無償版でも API の動作確認する上で十分な機能が備わっている。

５．Talend API Tester のインストール方法

Talend API Tester のインストール方法としては、まずブラウザの Chrome を起動して右上のメニュー欄より「その他のツール -> 拡張機能」を選択すると拡張機能の画面が表示される。

拡張機能の画面では既にインストールされている拡張機能が表示され、画面上部の検索欄に「Talend API Tester」を入力して検索する。
Talend API Tester の詳細ページが表示されれば、ボタン「Chrome に追加」をクリックしてインストールする。

インストールされると下図のように説明文が表示されるため、ブラウザ上部に常に表示させたい場合はピンマークをクリックすると、Chrome 利用時はすぎに利用できるようになる。

次に無償版を有効化するためにボタン「Use Talend API Tester – Free Edition」をクリックする。

ボタン「Use Talend API Tester – Free Edition」をクリックすると下図の API にリクエストするためのパスやデータを入力する画面が表示され、この画面より各 API にリクエストすることができる。

６．Talend API Tester の使い方

Talend API Tester の使い方は下図の 5 箇所を利用して API にリクエストを行う。
まず、(1) でデータを送信する形式を GET か POST か選択する。

次に (2) で API のパスを記入し、(3) で API にリクエストする際のヘッダー情報のパラメータを、(4）でそのパラメータに応じた値を入力する。
最後に (5) のボタン「Send」をクリックすると API がリクエストされ画面下部に API からの結果が表示される。

上図は実際に LINE の API にプッシュ通知のリクエストをした時の様子である。
LINE の API はトークに表示する文章を BODY 内に JSON 形式で記入する。
リクエストした後は画面下部に「HTTP/1.1 202」と表示され、リクエストが成功したのが確認できる。

関連記事