【入門編】Insomniaにおけるカスタム環境スクリプト（Pre-request/After-response）の高度な活用法とデバッグ裏技 – データベース・API管理活用バイブル

Insomniaカスタム環境スクリプト：API開発を劇的に効率化する魔法の杖

やっほー！API開発の世界へようこそ！Insomniaってツール、もう使ってるかな？「APIテストツール」って聞くと、ただリクエストを送ってレスポンスを見るだけのものってイメージかもしれないけど、Insomniaには、君のAPI開発を「劇的に楽にする」魔法が隠されているんだ。それが、今回紹介するカスタム環境スクリプト（Pre-request/After-response Script）さ！

「スクリプト？ JavaScriptとか難しそう…」って思った？ 大丈夫、大丈夫！この世界は、難しく考えすぎると面白くない。まずは、このスクリプトがどんな役割を果たして、どうやって君の毎日の作業をラクチンにしてくれるのか、一緒に見ていこう。そして、最後に、ちょっとした「裏技」もこっそり教えちゃうから、最後までしっかりついてきてね！

1. Insomniaって、そもそも何者？

Insomniaは、API開発者のための「お供」みたいなもの。REST、GraphQL、gRPC…いろんなAPIを、まるでブラウザのデベロッパーツールみたいに、簡単かつパワフルにテストできるんだ。

  • リクエストの作成と送信: URL、HTTPメソッド（GET, POSTなど）、ヘッダー、ボディを pretty に編集して、サクッと送信できる。
  • レスポンスの確認: 送信したリクエストに対するレスポンスを、JSON、XML、HTMLなど、整形された状態で分かりやすく表示してくれる。
  • 環境管理: 開発環境、ステージング環境、本番環境…それぞれでAPIのエンドポイントや認証情報が違うよね？ Insomniaなら、環境ごとに設定を切り替えて、リクエストを簡単に使い分けられる。

「ふむふむ、便利そうじゃん！」って思った？ まだまだ序の口さ。Insomniaの真価は、この後で語られるスクリプト機能にあるんだ。

2. Insomniaの「魔法の杖」：カスタム環境スクリプトとは？

Insomniaのカスタム環境スクリプトは、APIリクエストの「前」と「後」に、君が書いたJavaScriptコードを自動で実行してくれる機能だ。

  • Pre-request Script (リクエスト送信前スクリプト): リクエストが実際にサーバーに送られる「直前」に実行される。
  • After-response Script (レスポンス受信後スクリプト): サーバーからのレスポンスをInsomniaが受け取った「直後」に実行される。

「で、それがどうしたの？」って思うかもしれない。ここが重要！この「前」と「後」に、君だけの処理を挟み込めることで、手作業では面倒くさかったり、そもそも不可能だったりしたことが、驚くほど簡単にできるようになるんだ。

例えば…

  • リクエスト送信前に、毎回変わる署名（Signature）を自動生成する。
  • リクエスト送信前に、現在のタイムスタンプをヘッダーに自動で付与する。
  • レスポンスで受け取ったデータを、次のリクエストで使いやすいように加工する。
  • レスポンスの内容に応じて、テストの成否を自動判定する。

これらが、スクリプトを使えば、ほぼ自動で、しかも正確に実行できるようになるんだ。毎日の同じような作業にうんざりしていた君、朗報だよ！

3. Insomniaのインストールと基礎セットアップ：まずは「Hello, World!」から

さあ、まずはInsomniaを君のPCに迎え入れよう。

1. ダウンロードとインストール:
Insomniaの公式サイト (
The Collaborative API Development Platform
Leading Open Source API Development Platform for HTTP, REST, GraphQL, gRPC, SOAP, and WebSockets
insomnia.rest
(https://insomnia.rest/)) から、君のOSに合ったインストーラーをダウンロードして、指示に従ってインストールするだけ。簡単でしょ？

2. 新規ワークスペースの作成:
Insomniaを起動したら、まずは「Create a new Workspace」をクリック。ワークスペースは、プロジェクトごとにリクエストや環境設定をまとめるための箱みたいなものだと思えばいい。適当な名前（例: `MyAwesomeAPI`）を付けて、作成しよう。

3. 最初のAPIリクエストを作成:
ワークスペースができたら、画面左上の「+」ボタンをクリックして、「New Request」を選ぼう。

  • Method: まずは「GET」を選んでみよう。
  • URL: ここに、テストしたいAPIのURLを入力する。試しに、公開されているJSONPlaceholderの `/posts/1` (
    https://jsonplaceholder.typicode.com/posts/1
    jsonplaceholder.typicode.com
    (https://jsonplaceholder.typicode.com/posts/1)) を入れてみよう。
  • Sendボタン: 右上にある「Send」ボタンをクリック！

これで、APIからのレスポンスが画面下部に表示されるはずだ。これが、Insomniaの最も基本的な使い方。簡単だよね？

4. カスタム環境スクリプトを動かしてみよう！～HelloWorld編～

いよいよ、魔法の杖を使ってみよう！

目標: リクエストを送信する前に、コンソールに「Sending request now!」と表示させ、レスポンスを受け取った後に「Response received!」と表示させる。

1. 環境の選択:
画面左上にある「No Environment」と書かれた部分をクリックして、「Manage Environments」を選択。
「Create Environment」をクリックして、名前を `Development` などと付けよう。
作成した `Development` 環境を選択して、閉じる。

2. Pre-request Scriptの設定:

  • 画面右側のペインで、「Environment」タブの隣にある「Code Snippets」タブをクリック。
  • 「Pre-request Script」の項目を探す。
  • ここに、以下のJavaScriptコードをコピペしよう。

// Pre-request Script: リクエスト送信直前に実行されます
console.log(“Sending request now!”);
// response.headers.set(‘X-Insomnia-Timestamp’, new Date().toISOString()); // 例: ヘッダーにタイムスタンプを追加する場合

3. After-response Scriptの設定:

  • 「Code Snippets」タブの、「After-response Script」の項目を探す。
  • ここに、以下のJavaScriptコードをコピペしよう。

// After-response Script: レスポンス受信直後に実行されます
console.log(“Response received!”);
// console.log(“Response body:”, response.body); // 例: レスポンスボディをコンソールに出力する場合

4. 実行と確認:

  • 先ほど作成したGETリクエスト（`/posts/1`）の「Send」ボタンをもう一度クリック！
  • Insomniaの画面下部にある「Response」タブの隣にある「Console」タブをクリックしてみよう。

どうかな？
「Sending request now!」
「Response received!」
というメッセージが表示されているはずだ！

これで、君はInsomniaのスクリプト機能を使いこなす第一歩を踏み出した！おめでとう！

5. 現場で震えるほど役立つ！高度な活用術とデバッグ裏技

ここからは、君のAPI開発を「劇的に楽にする」ための、より実践的なテクニックを紹介しよう。

5.1. リクエスト送信前に「署名」を自動生成する

多くのAPI、特に認証が必要なAPIでは、リクエストごとにユニークな署名（Signature）を生成してリクエストに含める必要がある。この署名は、APIキー、シークレットキー、タイムスタンプ、リクエストボディなどを組み合わせて生成されることが多い。手作業でこれをやると、間違いやすく、時間もかかる。スクリプトで自動化しよう！

例：HMAC-SHA256 署名の生成

// Pre-request Script

// 環境変数からAPIキーとシークレットキーを取得
const apiKey = environment.get(‘api_key’);
const apiSecret = environment.get(‘api_secret’);

// リクエストのメタデータ
const method = request.getMethod(); // GET, POSTなど
const url = request.getUrl();
const timestamp = new Date().getTime(); // ミリ秒単位のタイムスタンプ

// リクエストボディ（POSTなどの場合）
// bodyが空の場合や、GETリクエストの場合は空文字列にするなどの考慮が必要
let body = ”;
if (request.getBody()) {
body = request.getBody().text || ”; // テキスト形式のボディを想定
}

// 署名生成のための文字列（API仕様によって異なる）
// 例: “timestamp={timestamp}&method={method}&url={url}&body={body}”
const stringToSign = `timestamp=${timestamp}&method=${method.toUpperCase()}&url=${encodeURIComponent(url)}&body=${encodeURIComponent(body)}`;

// HMAC-SHA256 で署名を生成
// InsomniaはNode.jsのCryptoモジュールを内蔵している
const crypto = require(‘crypto’);
const signature = crypto.createHmac(‘sha256’, apiSecret).update(stringToSign).digest(‘hex’);

// ヘッダーに署名とタイムスタンプを設定
// response.headers.set(‘X-API-Key’, apiKey); // APIキーもヘッダーに含める場合
response.headers.set(‘Authorization’, `Signature ${apiKey}:${signature}`);
response.headers.set(‘X-Timestamp’, timestamp.toString());

console.log(“Signature generated and set in headers.”);

ポイント:

  • `environment.get(‘variable_name’)`: 環境変数に設定した `api_key` や `api_secret` を取得できます。これらの値は、Insomniaの環境設定で定義しておきましょう。
  • `request.getMethod()`, `request.getUrl()`, `request.getBody()`: 現在のリクエストに関する情報を取得できます。
  • `response.headers.set(‘Header-Name’, ‘value’)`: リクエストヘッダーに新しいヘッダーを設定したり、既存のヘッダーを上書きしたりできます。
  • `crypto` モジュール: Node.js標準の暗号化モジュールが利用可能です。`require(‘crypto’)` でインポートして使います。

5.2. レスポンスデータを使った次のリクエストの準備

API連携では、あるAPIから取得したIDやトークンなどを、次のAPIリクエストで使うことがよくあります。これもスクリプトで自動化すれば、手作業でのコピペ地獄から解放されます！

例：ユーザー作成APIのレスポンスからIDを取得し、ユーザー詳細取得APIで利用する

まず、ユーザー作成API (`POST /users`) のリクエストを作成し、その `After-response Script` に以下を設定します。

// After-response Script for User Creation API

// レスポンスボディがJSON形式であることを想定
if (response.body && typeof response.body === ‘object’) {
const createdUser = response.body;

// 作成されたユーザーのIDを取得
if (createdUser.id) {
const userId = createdUser.id;

// 環境変数にユーザーIDを保存
environment.set(‘last_created_user_id’, userId);

console.log(`User created successfully. User ID: ${userId}. Saved to environment.`);
} else {
console.warn(“User creation response did not contain an ‘id’ field.”);
}
} else {
console.error(“Received unexpected response format for user creation.”);
}

次に、ユーザー詳細取得API (`GET /users/{userId}`) のリクエストを作成し、URLの `{userId}` 部分に環境変数を使えるようにします。

  • リクエストURLを `https://your-api.com/users/{{last_created_user_id}}` のように設定します。`{{variable_name}}` はInsomniaのテンプレートタグ構文です。
  • このリクエストの `Pre-request Script` は空でも構いません。

ポイント:

  • `environment.set(‘variable_name’, value)`: 環境変数に値を設定します。この値は、同じ環境内の他のリクエストの `Pre-request Script` や `After-response Script`、またはリクエストのURLやボディ内で `{{variable_name}}` という形式で参照できます。
  • `response.body`: レスポンスボディの内容にアクセスできます。JSONの場合は自動的にパースされたオブジェクトとして扱われます。
  • エラーハンドリング: `if` 文などでレスポンスの形式や必要なフィールドの存在を確認し、予期せぬ状況にも対応できるようにしましょう。

5.3. レスポンス内容に応じたテストとデバッグ

スクリプトを使えば、単にレスポンスを見るだけでなく、その内容を評価してテストの成否を判定したり、デバッグに役立つ情報を出力したりすることも可能です。

例：特定のステータスコードやレスポンスボディの内容でテスト結果を判定

// After-response Script

// 期待されるステータスコード
const expectedStatusCode = 200;
// 期待されるレスポンスボディの特定の値
const expectedMessage = “Operation successful”;

// ステータスコードのチェック
if (response.getStatusCode() === expectedStatusCode) {
console.log(`Status code is as expected (${expectedStatusCode}).`);
} else {
console.error(`Status code mismatch! Expected: ${expectedStatusCode}, Got: ${response.getStatusCode()}`);
// ここでテストを失敗させるような処理をすることも可能（例: throw new Error(…)）
}

// レスポンスボディのチェック (JSON形式を想定)
if (response.body && response.body.message === expectedMessage) {
console.log(`Response message is as expected: “${expectedMessage}”.`);
} else if (response.body && response.body.message) {
console.error(`Response message mismatch! Expected: “${expectedMessage}”, Got: “${response.body.message}”`);
} else {
console.warn(“Response body does not contain a ‘message’ field or is not in the expected format.”);
}

// レスポンスヘッダーのチェック例
// const contentType = response.getHeaders()[‘content-type’];
// if (contentType && contentType.includes(‘application/json’)) {
// console.log(“Content-Type is application/json.”);
// } else {
// console.warn(`Unexpected Content-Type: ${contentType}`);
// }

デバッグ裏技：`console.log` を最大限に活用！

スクリプトのデバッグで最も強力な味方は、`console.log` です。

  • 変数の値を確認: `console.log(“User ID:”, userId);`
  • 処理の流れを追跡: `console.log(“Starting signature generation…”);`
  • レスポンスボディの内容を丸ごと確認: `console.log(“Full response body:”, response.body);`
  • ヘッダーの内容を確認: `console.log(“Response headers:”, response.getHeaders());`

これらの `console.log` の出力を、Insomniaの「Console」タブで確認しながら、スクリプトの動作を追っていきましょう。まるでブラウザのデベロッパーツールのように、APIリクエストの裏側を覗き見ることができます。

6. まとめ：InsomniaスクリプトでAPI開発の「質」と「速さ」を爆上げ！

どうだったかな？ Insomniaのカスタム環境スクリプトは、単なる「おまけ機能」なんかじゃない。API開発における定型的で面倒な作業を自動化し、複雑なAPI仕様への対応を容易にする、まさに「魔法の杖」なんだ。

  • Pre-request Script: リクエスト送信前に、署名生成、タイムスタンプ付与、動的なパラメータ設定などを自動化。
  • After-response Script: レスポンスデータの加工、次のリクエストへの引き渡し、テスト結果の判定などを自動化。
  • `environment` オブジェクト: リクエスト間でデータを共有し、状態管理を容易にする。
  • `request` オブジェクト: 現在のリクエストの詳細情報を取得。
  • `response` オブジェクト: 受信したレスポンスの詳細情報（ステータスコード、ヘッダー、ボディ）にアクセス。
  • `console.log`: 疑わしい挙動のデバッグに大活躍！

これらの機能をマスターすれば、君のAPI開発は劇的に効率化される。単に速くなるだけでなく、手作業によるミスが減り、API仕様への対応精度も格段に向上するはずだ。

さあ、今日からInsomniaのスクリプト機能を積極的に使ってみてほしい。最初はちょっと戸惑うかもしれないけど、一つ一つ試していくうちに、そのパワフルさにきっと驚くはず。

「これをマスターすれば、毎日の作業が劇的に楽になりますよ」

そう、これは君への約束だ。API開発の冒険を、もっともっと楽しんでいこう！

スポンサーリンク
タイトルとURLをコピーしました