Android、iOSアプリ開発でAPIのリクエスト、レスポンスを確認するために使っているツール「Charles」について記載します。
スマートフォンアプリ開発で是非、利用して頂ければと思います！
Charlesについて
CharlesはHTTPプロキシ、HTTPモニタを行うためのツールです。
このような書き方をすると難しいツールのように感じてしまうかもしれませんが、使い方は至ってシンプルです。
Charlesを使うことで、通信時のリクエスト、レスポンスの中身を除いたり、値を好きに書き換えたりすることができます。
APIが異常系のレスポンスを返してきた場合のアプリ側の挙動を確認したい場合に、サーバー側の設定やDBの値を変更する必要がなくなります。
また、この記事ではOSX + iOS + Androidで使うことを前提に記載します。
もちろん、WindowsやLinuxでも使うことができますので参考にして頂ければと思います。
環境構築
インストール
１. 以下のURLより最新版のCharlesをインストールすることができます
https://www.charlesproxy.com/download/
２. MacをWifiに接続します。
３. Charlesを起動します。初回起動時には下記のダイアログが表示されます。
ここでは、Charles起動時にプロキシの設定をCharlesに切り替えるかどうかの設定を行います。
特段の事象がない限りは Grant Privileges を選択することをオススメします。
４. 次に下記のダイアログが表示されます。
CharlesをFirefoxでも利用する場合は Install を選択します。
利用しない場合は __Cancel__を選択します。
５. Charles起動後、メニューから Proxy -> SSL Proxying Settingsを選択します。
６. Add ボタンを押下し、Hostに * を入力後、OKを押下します。
Macの設定
メニュー -> Help -> SSL Proxying -> Install Charles Root Certificate より証明書をインストールします。
「このルート証明書は信頼されていません」と表示されてしまう場合は以下手順を行うことで解決することができます。
- 証明書 __Charles Proxy Custom Root Certificate__をダブルクリックする。
- 「信頼タブ」を開く。
- この証明書を使用するとき -> 常に信頼する を選択する。
iPhoneの設定
１. メニュー -> Help -> Local IP Addressを選択し、MacのIPアドレスを調べます。
２. iPhoneをMacと同じWifiに接続します。
３. WifiのHTTPプロキシの設定にて、サーバにMacのIPアドレス、ポートに8888を入力します。
４. Charles側で以下のダイアログが表示されるので Allow を選択します。
５. 以下URLにアクセスし、プロファイルをインストールします
http://www.charlesproxy.com/getssl
Androidの設定
１. AndroidをMacと同じWifiに接続します。
２. WifiのHTTPプロキシの設定にて、プロキシホスト名にMacのIPアドレス、プロキシポートに8888を入力し、保存します。
３. Charles側で以下のダイアログが表示されるので Allow を選択します。
４. 以下URLにアクセスし、プロファイルをインストールします
http://www.charlesproxy.com/getssl
パケットをキャプチャする
下記のようにレスポンスの中身を確認することができます。
リクエスト、レスポンスを書き換える
１. iOS、Androidのアプリ内で通信処理を行います。
２. Structureタブを選択します。
３. 任意のURLを選択し、右クリック -> BreakPointをチェックします。
４. 再度右クリックし、BreakPointにチェックマークが入っていればOKです。
５. iOS、Androidのアプリ内で再度通信処理を行います。
６. 通信処理ブレーク後、Edit Response(Edit Request)タブを押下します。
７. 通信データを任意に書き換えた後、Executeボタンを押下します。
※補足Responseのみを書き換える場合、メニュー -> Proxy -> BreakPoint Setting -> Requsetチェックを外す必要があります。
おわりに
Charlesにはこの記事で紹介した以外にも様々な機能があります。
Charlesは有料ライセンスですが、起動後30分で終了する（再起起動すればまた使えます）制限付きで無料で使うことができます。
簡単で便利な機能が多くあるので、是非一度使ってみてはいかがでしょうか。