こんにちは！今年もコナン映画にいってきました、コナンでは服部派のエンジニア結城(@super_manner)です(*´ڡ`●) さて、今回はAPIをチームで開発するうえでつよーい味方になるツールを２つ使い比べた結果をご紹介しようと思います!!
そもそもPawとInsomniaとは？
双方ともREST APIクライアントです。
Paw paw.cloud Insomnia insomnia.rest
APIを作成していると、POSTする必要があったり、User-AgentやRequestHeaderによる制約を受けたりで
プラグイン追加が加速したりしますよね。
うっかりそのまま他のサイトを閲覧して全部がxmlで表示されたりすることもしばしば。
そんな煩わしさも、これらのクライアントを使うことで開放されるのです!!
APIをメインに開発されている方にはもはや必需品になっているかもしれませんね。
百聞は一見にしかずなので、試しに国土交通省のAPIを叩いた画面を見てみましょう。 *1
PawでGETした様子
InsomniaでGETした様子
このように、各種設定をしてあげることで簡単に何が返ってくるかを確認することができます。
共有ツールとしてのおすすめポイント
わかりやすいUIなので、初めて使う方でも迷うことなく使っていただけるのがいいところです。
以下、参考画像はInsomniaのものですが、Pawも同じ機能がついています。(詳しい比較は後述します)
このように、階層構造でendpointを管理できたり、パラメータやヘッダ情報もまるっと共有できます！
こちらは、環境変数を管理できる機能です。共通して使う変数と、そうでないものを切り分けできて便利です。
また、snippetを自動生成してくれるのでPull Request等に貼り付けると、レビュワーに優しいですね＼(^^)／
２つのツールの機能比較
さて、ツールの紹介が終わったところで本題です。
コネヒトのAPI開発陣はトライアル期間を経て２つのツールの選択をせまられました…
ツールの選択はいついかなるときも難しいものですよね。
ということで、２つのツールを比較し、できること、できないことを表にしてみましたので御覧ください。
| Paw | Insomnia | 備考 | |
|---|---|---|---|
| RequestHeaderの設定 | ○ | ○ | |
| パラメータの設定 | ○ | ○ | |
| cookieの設定 | ○ | ○ | |
| 環境ごとの変数の設定 | ○ | ○ | 例えばですが, {local/dev/stg/prod} 等で別途環境変数をマネージする機能があります |
| snippet発行 | ○ | ○ | ただし双方で発行できるsnippetの種類に違いがあります |
| 設定のimport/export | ○ | ○ | |
| 複数のapiを同時に叩く | ○ | ✗ | |
| teamアカウントを発行できる | ○ | ○ | teamを作成することで、登録したapiの設定を共有できます |
| ブランチ機能がある | ○ | ✗ | ブランチ機能については後述します |
| 料金 | 個人プラン:$49.99 チームプラン:月額$10 |
制限付き$0 有料プラン:月額$5 チームプラン月額:$8 |
Pawのほうが少し料金が高めですが、その分機能が多いですね。
InsomniaでできることはPawですべて網羅していると言っても過言ではないでしょう。(もちろんsnippetの発行形式など細かな違いはあります)
また、個人でcloudにプロジェクトをもつことのできる個人プランはいいお値段です！
そんな多機能なPawですが、中でも特筆すべき機能としてブランチ機能があります。
Pawのブランチ機能について
公式のドキュメントが非常に丁寧に書いてあるので、基本的な使い方はこちらを参照していただけると良いかと思います。 さぁ、セクションタイトルを見てみましょう！
Manage your workflow with branches
何処かで見たような機能ですね。そうです！我々も馴染みが深いgitと同じです。
開発中のapiなどはいきなりみんなに共有しても「これ開発中です！」と宣言して回る訳にはいきません。
そのような場合は自分用にブランチを切って、そこで登録していけばmasterはスッキリと余分なものが登録されないまま保たれます！
チームにとっても、自分にとっても常に動くものが簡単に手に入りますｂ
Insomniaのデータ共有はどうなっているの？
先程の表で述べた通りInsomniaにもteam機能があり、workspaceとよばれる箱でデータを共有することができます。
が、現時点では手元のデータとremoteのworkspaceの同期だけで、git pullのような機能は実装されていません。
つまり、手元で変更してしまうとその時点で残念ながらremoteのデータとはズレが生じてしまい、復旧の術がないということです。
dropboxをイメージしていただけるとわかりやすいかと思います。
cloud上のworkspaceと完全一致していない場合は下図のようにどれだけズレているのかが%で表示されています。
英語ドキュメントの読み逃しがこわかったため、運営チームに問い合わせをさせていただいたところ、下記の返答を頂いたので将来的には実装されるかもしれませんね！！期待して待ちましょう。
Hi Mana,
Thanks for reaching out :)
There is no official way to do a pull master currently. For now, I recommend duplicating the request (or folder) that you want to edit so that you do not modify the existing data.
I will be sure to consider this use case as I improve the team features in the future.
Let me know if that works for you.
まとめ
２つのツールの機能比較をして、現在私のチームではInsomniaにチーム課金して使用しています。
なぜなら、いまのところREST Clientの使用理由が
- 実装したAPIの各環境での実行確認をするため
- テストで使用したrequest情報を完全再現してレビュー時にレビュワーにわかりやすくするため
の２つであるからです。
ですので、機能としてはシンプルで、料金もお財布に優しいInsomniaを採用し日々の開発に役立てています。
しかし今回記事を書くにあたって改めて調べてみるとPawの機能はまだ全然つかいこなせていなかったなぁと思ったので、
今後も使って有用だった機能があれば引き続き紹介していきたいと思います！*2
双方ともまだまだ開発は進んでいるようなので、みなさんもよければぜひ活用して素敵なAPIライフを送ってください！
