覚えたら書く

IT関係のデベロッパとして日々覚えたことを書き残したいです。twitter: @yyoshikaw

DHC REST Client - RESTのAPIを実行するならこのツール

昨今、アプリ間の連携のためにRESTでのAPIを公開することも多いと思います。 そのようなREST(やWebの)APIを開発する場合に、動作確認のためには、そのRESTのAPIを実行するためのクライアントが必要になります。 もちろん自前で作ることもできますが正直大変です。

こういう場合には、Chromeのアドオンとして提供されているDHCがとても便利です。

DHC REST Client(DHC)は、その名の通りRESTを実行するためのクライアントのツールです。


インストールから起動まで

導入手順は一般的なChromeのアドオンと同じです

先に示したDHCのページにアクセスして「CHROMEに追加」をクリックします

f:id:nini_y:20161027225626p:plain

以下の通知が表示されたら「拡張機能を追加」をクリックします

f:id:nini_y:20161027225708p:plain

Chromeの右上にDHCのボタンが追加されているのでクリックします

f:id:nini_y:20161027230125p:plain

DHCが起動します

f:id:nini_y:20161027230132p:plain


基本的な使い方

アクセスするURLを入力し、HTTPメソッドを選択して、「Send」ボタンをクリックします

f:id:nini_y:20161027231209p:plain

サーバからの応答内容(ステータスコード、ヘッダー、レスポンスボディ)が表示されます

f:id:nini_y:20161027231356p:plain


GETでqueryパラメータを指定する

queryパラメータを指定してGETのリクエストを送信する手順は以下の通りです

(queryパラメータを除いた)URLを入力した後、"?[0]" の部分をクリックします

f:id:nini_y:20161027233156p:plain

queryパラメータを入力するための欄が表示させるために+の部分をクリックします

f:id:nini_y:20161027233414p:plain

queryパラメータを入力するための欄が表示されます(+を押した分だけ欄が追加されます)

f:id:nini_y:20161027233420p:plain

queryパラメータの入力欄にパラメータ名と値を入力し、「Send」ボタンをクリックします

f:id:nini_y:20161027233504p:plain

応答内容が表示されます

f:id:nini_y:20161027233554p:plain

※実際には、queryパラメータまで含めたURLをURLのテキストボックスに入力することでも同じことが実現できます


POSTでJSONメッセージを送信する

POSTでRequestBodyにJSONメッセージをセットしてリクエストを送信します

メソッドのリストボックスでPOSTを選択します。選択するとBODYのテキストエリアが表示されます

f:id:nini_y:20161201171655p:plain

BODYのテキストエリアにJSONメッセージを入力します。入力後、テキストエリアの下にあるJSONの箇所をクリックします。
そうすると自動的にリクエストヘッダーにContent-Type=application/jsonがセットされます

f:id:nini_y:20161028005051p:plain

Sendボタンをクリックするとリクエストが送信され、応答が返ってきます

f:id:nini_y:20161028004918p:plain


まとめ

  • DHCを使うと好きなHTTPリクエストを簡単に送信して、応答を確認することができます
  • GET、POSTやその他メソッドの実行も可能です
  • リクエストのHeaderやBodyを指定することも可能です
  • リクエストの条件を名前を付けて保存しておくことも可能です。複雑なパラメータ指定などをする場合にとても役に立ちます。

というわけで、テストの際などには相当な活躍が見込まれるツールです。