APIテストを自動化するには、リクエストを連続実行するだけでなく、毎回のデータ準備、結果の判定、後片付けを一つの流れにします。前の実行で作ったデータに依存していると、同じテストでも順番や実行環境によって結果が変わってしまいます。
ここでは、既にNewmanとPostmanのv2.1コレクションを使っているチーム向けに、作成・取得・削除を繰り返せるテストを説明します。2026年10月28日確認時点で、Newmanは非推奨となり保守が終了しています。公式は代わりにPostman CLIを案内しているため、新規導入ではそちらを確認してください。本稿は既存構成を読み解く例です。出典:Newman CLI overview
API自体は架空の仕様です。パス・応答・権限・削除方法は対象APIへ合わせ、データ分離や中断時の回収という考え方を持ち帰ってください。
最初は、一つの業務操作を最後まで実行する
最初から全APIを自動化するより、一つの操作について「データを作る→読み直す→消す」を通せるようにすると、実行基盤とデータ管理の問題を切り分けやすくなります。
次の仮の注文APIを例にします。検証専用の環境と利用者があり、作成したデータを削除できることが前提です。
| 順番 | リクエスト | 仮の期待結果 |
|---|---|---|
| 01 Create | POST {{baseUrl}}/orders |
201。文字列のidと、指定したclientRef・quantityを返す |
| 02 Read | GET {{baseUrl}}/orders/{{orderId}} |
200。作成したid・clientRef・quantityを返す |
| 03 Delete | DELETE {{baseUrl}}/orders/{{orderId}} |
204。今回作った注文を削除する |
Postmanでは、この順番で同じコレクション直下にリクエストを保存します。baseUrlは検証用のURLに設定し、認証には検証用の資格情報を使います。コレクションや環境ファイルを共有するときは、秘密値を含めない状態と、実行時に値を渡す仕組みを分けます。
応答の検証そのものを整理したい場合は、APIテストの進め方を参照してください。本記事では、同じ確認を繰り返しても互いに影響しない構成へ進みます。
実行ごとに識別子を作り、作成したIDを次へ渡す
01 CreateのPre-requestに、次の例を設定します。clientRefはテストデータを見分ける目印、orderIdはサーバーが返す注文IDです。新しい反復の開始時に、前の注文IDを空に戻します。
pm.variables.set("clientRef", "api-test-" + pm.variables.replaceIn("{{$guid}}"));
pm.variables.set("orderId", "");
Postmanの動的変数と、実行中に使うローカル変数を組み合わせた例です。識別用のランダム値を生成できても、データの隔離や削除まで自動で保証されるわけではありません。出典:動的変数、変数のスコープ
01 CreateのBodyをrawのJSONにし、Content-Typeをapplication/jsonに設定します。
{
"clientRef": "{{clientRef}}",
"quantity": 1
}
Post-responseでは、IDを得られた場合だけ次へ進みます。仮APIではIDは空でない文字列と決めています。応答を解析できない場合やIDがない場合は、その反復を停止し、空のIDで取得・削除を送らないようにします。
let created;
try { created = pm.response.json(); } catch (_) {}
const usable = pm.response.code === 201 && created &&
typeof created.id === "string" && created.id.length > 0;
pm.test("作成成功と注文IDを確認", function () {
pm.expect(Boolean(usable)).to.eql(true);
});
if (!usable) {
pm.execution.setNextRequest(null);
} else {
pm.variables.set("orderId", created.id);
pm.test("作成内容を確認", function () {
pm.expect(created.clientRef).to.eql(pm.variables.get("clientRef"));
pm.expect(created.quantity).to.eql(1);
});
}
ここでは作成内容のassertionより先にIDを保存しています。内容の不一致が出ても、IDが分かるデータは後続の削除対象として追えるためです。setNextRequest(null)は、コレクション実行中の現在の反復を停止する指定です。Postmanでリクエストを単独送信した場合と、コレクションを実行した場合では、この制御の適用が異なります。出典:Postmanのテスト例、実行順の制御
02 ReadのPost-responseでは、応答コードと保存された内容を確認します。
pm.test("今回作った注文を取得", function () {
pm.response.to.have.status(200);
const actual = pm.response.json();
pm.expect(actual.id).to.eql(pm.variables.get("orderId"));
pm.expect(actual.clientRef).to.eql(pm.variables.get("clientRef"));
pm.expect(actual.quantity).to.eql(1);
});
03 Deleteには、仮仕様どおりの削除結果を確認するテストを置きます。
pm.test("今回の注文を削除", function () {
pm.response.to.have.status(204);
});
実APIが非同期削除など別の仕様なら、204という期待値をそのまま使わず、完了の確認条件も合わせて設計します。各実行が自分のIDだけを扱うことを基本にし、共有の固定注文を複数のテストが更新しないようにします。
CLIで二度実行し、結果と終了コードをCIへ渡す
Newmanはv2.1 JSON形式のコレクションを実行しますが、v3には対応せず、今後の更新や修正も提供されません。以下はNode.jsとNewmanが既にある環境での既存構成例です。コレクションをv2.1形式のorders.postman_collection.json、実行環境をtest.postman_environment.jsonとして用意します。保守するCIではPostman CLIへの移行も計画してください。出典:Newman CLI overview
次は二反復し、端末表示とJUnit形式の結果を出す例です。秘密情報はコマンドの文字列へ直接書き込みません。
newman run orders.postman_collection.json -e test.postman_environment.json -n 2 --timeout-request 10000 --reporters cli,junit --reporter-junit-export reports/api-tests.xml
反復回数、要求の待ち時間、レポーターはNewmanのオプションです。ここでの10秒は例であり、対象APIの所要時間や検証目的に合わせます。既存テストの見直しでは、二回とも作成・取得・削除が通るか、使った目印が異なるか、実行後にデータが残らないかを確認します。出典:Newman README
CIには同じコマンドを登録し、テスト失敗を成功へ読み替える設定を付けないようにします。--suppress-exit-codeで失敗を隠したり、失敗時も常に成功を返すシェル処理で包んだりすると、テストが失敗しても次の工程が進む原因になります。JUnitレポートは成功時だけでなく失敗時も保存する設計にします。
この例では、途中のassertion失敗後も後続の削除へ進めるため、早期終了用の--bailは付けていません。ただし、プロセス停止や通信障害まで含めて削除が必ず実行される、という意味ではありません。
中断時の後片付けを、正常な削除と別に用意する
作成処理がサーバーで成功したあとに応答が途切れた場合、クライアントはIDを受け取れないことがあります。そのまま同じ作成要求を繰り返すと、APIの仕様によってはデータが重複します。
そこで、検証環境には次のような回収方法を事前に決めます。
- テスト専用のテナントや利用者にデータを分離する。
- clientRefなどの実行識別子を保存し、残ったデータを正規の方法で探せるようにする。
- 実行終了時に回収できないものは、対象と期限を限定した別の清掃処理で確認する。
- 削除に失敗した場合も記録を残し、テスト成功の件数だけを見て終わらせない。
これは本記事の運用設計例です。識別子での検索や期限付き削除がAPIに備わっているとは限らないため、利用できない場合は隔離環境を作り直すなど、対象システムに合う回収方法を選びます。テストのために本番データを一括削除する方法へ置き換えないでください。
失敗を「APIの不具合」だけにまとめない
結果を見るときは、仕様との不一致、環境の問題、テストデータの競合、テスト自体の誤りを分けます。たとえば「一回目は成功し二回目だけ409」なら、固定値の再利用や前回データの残存を調べる材料になりますが、それだけで原因を断定はできません。
記録する項目は、対象APIと版、実行したコレクションの版、テスト名、期待結果と実際の結果、秘密でない要求ID、後片付けの結果などです。トークンや個人情報がレポートへ残らない範囲で、同じ条件を再現できる情報を残します。
自動化の入口は、毎回自分のデータを準備し、判定と後片付けまで追える小さなテストです。 その一式をチームで共有できれば、対象APIやケースを増やすときも、何を引き継ぐかを具体的に話し合えます。