【インソムニア】

Insomnia とは?

最終更新:
💡 眠れないほどAPIテストが楽しくなるクライアント

REST APIやGraphQL、gRPC、WebSocketなどに対応するAPIクライアント。リクエストを組み立てて送信し、レスポンスを確認してAPIのテストやデバッグに使う。

📌 このページのポイント
InsomniaでAPIを確かめるGET /users認証・本文を設定200 OK応答を確認扱えるリクエストの例REST APIGraphQLgRPCWebSocket保存先も選べるローカル / Git同期 / クラウド同期
リクエストと応答を比べてAPIを確認する。保存方法や秘密情報の共有範囲も選ぶ。
ひよこ ひよこ
InsomniaってPostmanと同じようなツールなの?
ペンギン先生 ペンギン先生
どちらもAPIクライアントだよ。Insomniaでは送信先、ヘッダー、認証、本文などを設定し、返ってきた内容を確認できる。軽さや使いやすさは環境と作業によって違うので、片方が常に優れているという関係ではないね。
ひよこ ひよこ
GraphQLやgRPCも使えるの?
ペンギン先生 ペンギン先生
対応しているよ。コレクション内にGraphQLやgRPCのリクエストを作れる。ただし設定は種類によって違い、gRPCをHTTPと同じ設定で送れるわけではない。接続先の仕様や認証などに合わせて準備するんだ。
ひよこ ひよこ
環境変数って何に使うの?
ペンギン先生 ペンギン先生
開発環境と本番で違うURLなどを変数にして切り替えるよ。トークンを入れる場合は保存先と共有範囲にも注意する。公式資料のprivate sub-environmentは同期・エクスポートされないけれど、通常の環境変数がすべて非公開になるわけではないんだ。
ひよこ ひよこ
チームで使うにはGitに保存するの?
ペンギン先生 ペンギン先生
Git Syncでリクエストなどをリポジトリ管理する方法も、Cloud Syncで共有する方法もあるよ。Local VaultやScratch Padはローカル保存の選択肢。Git同期だけのツールではないし、Gitに秘密情報を入れないようにする責任は利用者にもあるんだ。
ひよこ ひよこ
送信できたらテストは成功?
ペンギン先生 ペンギン先生
送信できたことと、APIが期待どおり動いたことは別だよ。レスポンスの状態や内容を期待値と比べて確認する。APIクライアントはその作業を助けるもので、1回の成功でAPI全体の品質が保証されるわけではないね。
ペンギン
まとめ:ざっくりこれだけ覚えればOK!
「Insomnia」って出てきたら「いろんなAPIを手軽にテストできるツール」と思えればだいたいOK!
📖 おまけ:英語の意味
「Insomnia」 = 不眠症
💬 Insomniaは不眠症という意味の英単語だよ。ツール名として使われているけれど、名前だけから開発者の意図や性能を判断するものではないね

参考資料

← 用語集にもどる