💡

Postman / Newman でよく使う pm.test・pm.expect・変数操作まとめ

に公開

はじめに

Postman / Newman で API テストを書くときによく使うのが

  • pm.test(テストケース定義)
  • pm.expect(アサーション)
  • pm.environment.set / pm.globals.set(変数の保存)
    あたりです。
    この記事では、よく使うパターンだけに絞ってサクッとコピペできる形でまとめます。

基本のテスト構造

JSON をパースして共通変数に

Tests タブによく書くお決まりコード:

const jsonData = pm.response.json();

以降のテストで jsonData を使い回します。

pm.test の基本

pm.test("テスト名", function () {
  // ここで pm.expect を使ってチェック
});

複数書けばそのまま複数テストになります。

pm.test("ステータスコードが 200", function () {
  pm.expect(pm.response.code).to.eql(200);
});

pm.test("レスポンスが JSON", function () {
  pm.expect(pm.response.headers.get("Content-Type")).to.include("application/json");
});

pm.expect のよく使うパターン集

1. ステータスコード

pm.test("ステータスコードが 200", function () {
  pm.expect(pm.response.code).to.eql(200);   // 完全一致
});

2. レスポンスタイム

pm.test("レスポンス時間が 1 秒未満", function () {
  pm.expect(pm.response.responseTime).to.be.below(1000); // 1000ms 未満
});

3. JSON のプロパティ存在確認

const jsonData = pm.response.json();

pm.test("dataDetail に image プロパティがある", function () {
  pm.expect(jsonData.dataDetail).to.have.property("image");
});

4. null ではないことをチェック

pm.test("image が null / undefined ではない", function () {
  pm.expect(jsonData.dataDetail.image).to.exist; // null / undefined を弾く
});

5. 配列で要素数 > 0

pm.test("users は 1 件以上の配列", function () {
  pm.expect(jsonData.users).to.be.an("array");
  pm.expect(jsonData.users.length).to.be.above(0);
});

6. 数値の比較

pm.test("count が 0 より大きい", function () {
  pm.expect(jsonData.count).to.be.above(0);     // > 0
  // pm.expect(jsonData.count).to.be.at.least(1); // >= 1 でもOK
});

7. 文字列に特定の値が含まれる

pm.test("message に 'success' を含む", function () {
  pm.expect(jsonData.message).to.include("success");
});

8. ヘッダチェック

pm.test("Content-Type が JSON", function () {
  pm.expect(pm.response.headers.get("Content-Type")).to.include("application/json");
});

9. 型チェック

pm.test("id が数値", function () {
  pm.expect(jsonData.id).to.be.a("number");
});

pm.test("name が文字列", function () {
  pm.expect(jsonData.name).to.be.a("string");
});

環境変数・グローバル変数の操作

1. 変数の種類ざっくり

  • Environment(環境変数)
    • 環境ごと(dev / stg / prod など)に変えたい値
    • 例:baseUrl, authToken など
  • Globals(グローバル変数)
    • 全体で共通の値に使えるが、濫用は非推奨
    • 基本は Environment / Collection 変数 を優先

2. 変数の設定

Environment 変数にセット

pm.environment.set("authToken", jsonData.token);

Globals にセット

pm.globals.set("sessionId", jsonData.sessionId);

3. 変数の取得

const token = pm.environment.get("authToken");
const sessionId = pm.globals.get("sessionId");

URL や Body では {{authToken}} 形式でも参照できます。
例:

GET {{baseUrl}}/users

Authorization: Bearer {{authToken}}

4. 変数の削除

pm.environment.unset("authToken");
pm.globals.unset("sessionId");

典型的な「ログイン → トークン保存 → 次リクエストで利用」の流れ

ログイン API(Tests タブ)例

const jsonData = pm.response.json();

pm.test("ログイン成功", function () {
  pm.expect(pm.response.code).to.eql(200);
  pm.expect(jsonData).to.have.property("token");
});

// トークンを環境変数に保存
pm.environment.set("authToken", jsonData.token);

別のリクエストで利用

Headers に以下を設定:

Authorization: Bearer {{authToken}}

Newman での実行

Postman で書いた pm.test / pm.expect / pm.environment.set などは
そのまま Newman でも実行されます。

実行例

npx newman run ./collection.json \
  -e ./env.json \
  --reporters cli,html \
  --reporter-html-export report.html
  • collection.json:Postman コレクションのエクスポート
  • env.json:Postman environment のエクスポート
  • pm.test がそのままテスト結果としてレポートされます

よく使うスニペットまとめ(コピペ用)

// JSON 共通変数
const jsonData = pm.response.json();

// ステータスコード
pm.test("ステータスコードが 200", function () {
  pm.expect(pm.response.code).to.eql(200);
});

// レスポンスタイム
pm.test("レスポンス時間が 1 秒未満", function () {
  pm.expect(pm.response.responseTime).to.be.below(1000);
});

// プロパティ & null チェック
pm.test("dataDetail.image が存在し null ではない", function () {
  pm.expect(jsonData.dataDetail).to.have.property("image");
  pm.expect(jsonData.dataDetail.image).to.exist;
});

// 配列で件数 > 0
pm.test("koji が 1 件以上", function () {
  pm.expect(jsonData.users).to.be.an("array");
  pm.expect(jsonData.users.length).to.be.above(0);
});

// 数値 > 0
pm.test("count > 0", function () {
  pm.expect(jsonData.count).to.be.above(0);
});

// 文字列を含む
pm.test("message に success", function () {
  pm.expect(jsonData.message).to.include("success");
});

// ヘッダチェック
pm.test("Content-Type が JSON", function () {
  pm.expect(pm.response.headers.get("Content-Type")).to.include("application/json");
});

// 変数保存
pm.environment.set("authToken", jsonData.token);

おわりに

  • pm.test:テストケースの入れ物
  • pm.expect:実際のチェック(Chai 形式)
  • pm.environment.set / pm.globals.set:値の受け渡し
    この3つを押さえておくだけで、Postman / Newman の自動テストはかなり書けます。

Discussion