RESTful APIのテストツール(アドオン)「RestClient」の使い方

firefox

RESTfulなAPIをコーディングした後、APIの単体レベルのテストはどのように行っていますか?
ブラウザへAPIのUILを入れて実行するか、テスト用のHTMLファイルを作ってテストされる方も多いのではないでしょうか。

RESTfulなAPIは、HTMLのフォームがサポートしていないPUT・DELETEメソッドを許可しています。
今回は、PUT・DELETEメソッドのテストも楽々出来るツール(FireFoxアドオン)を紹介します。

[スポンサーリンク]

このページでやること

FireFoxアドオンのRestClientの使い方を紹介します。

RestClientのインストール

まずは、FireFoxへアドオンRestClientをインストールしましょう。

restclient-firefox-addons1

RestClientの起動

FireFoxの「ツール」>「RestClient」で起動出来ます。

起動後の画面です。

restclient-firefox-addons2

GETメソッドのAPIを実行してみる

RestClientでGETメソッドのAPIを実行してみましょう。
今回は、自作APIをローカルサーバ上で実行しました。

Methodで「GET」を選択して、APIのURLを入力して実行します。
もしパラメータを渡したいのであれば、以下のように通常のGETパラメータを渡すようにURLの後ろへパラメータをつけます。
http://localhost:8080/sample/data?data=1

restclient-firefox-addons3

API実行後、Responseの「Response Body」タブでAPIのレスポンスデータを参照することが出来ます。

restclient-firefox-addons4

POSTメソッドのAPIを実行してみる

Methodで「POST」を選択して、APIを実行します。
もしパラメータを渡したいのであれば、Body部分へパラメータを指定します。
コチラのサンプルでは、Json形式で記述していますが、これはAPI側がJsonに対応しているため可能な指定方法です。実行するAPIの仕様を把握しておきましょう。

restclient-firefox-addons5

HTTPヘッダへ値を追加する

RestClientでは、HTTPヘッダを独自にカスタムすることも可能です。
画面上部の「Headers > Custom Header」をクリックすると以下のような画面が表示されます。
これは非常に便利!

restclient-firefox-addons6

HTTPヘッダへ値を追加するとこのように出てきます。

restclient-firefox-addons7

さいごに

FireFoxのアドオン「RestClient」はいかがでしたか?
PUT・DELETEメソッドが使えるので、RESTful APIのテストには非常に有効なツールだと思います。
わたし個人的には、HTTPヘッダをカスタム出来ることが非常に嬉しいです。ブラウザへURL直接入力では、HTTPヘッダのカスタムは出来ないですからね。

今回はRestClientの基本的な使い方を解説しました。
RestClientで出来ることは今回書いたこと以外にも色々あります。是非発見してみて下さい。
それでは!