ドキュメント

Computer Science

Postman

Postman

Collection 変数（Collection 専用、安全）

メソッド / 属性(ぞくせい)	範囲(はんい) / 適用(てきよう)	用途(ようと)	例(れい)
`pm.variables.set("key", value)`	現在(げんざい) の Collection 内(ない) のみ有効(ゆうこう)	前(まえ) の API 結果(けっか) を次(つぎ) の API に保存(ほぞん)	`pm.variables.set("prevId", 123);`
`pm.variables.get("key")`	Collection 内(ない) のみ	Collection 変数(へんすう) を読(よ) み取(と) る	`let id = pm.variables.get("prevId");`
`pm.variables.unset("key")`	Collection 内(ない) のみ	Collection 変数(へんすう) を削除(さくじょ)	`pm.variables.unset("prevId");`

他(ほか) の Collection に影響(えいきょう) しない、安全(あんぜん)

Environment 変数（特定 Environment 向け、Collection を跨いで使用可能）

メソッド / 属性(ぞくせい)	範囲(はんい) / 適用(てきよう)	用途(ようと)	例(れい)
`pm.environment.set("key", value)`	現在(げんざい) 選択(せんたく) 中(ちゅう) の Environment	異(こと) なる環境(かんきょう) のパラメータを保存(ほぞん)	`pm.environment.set("baseUrl", "https://dev.api.com");`
`pm.environment.get("key")`	現在(げんざい) 選択(せんたく) 中(ちゅう) の Environment	環境(かんきょう) 変数(へんすう) を読(よ) み取(と) る	`let url = pm.environment.get("baseUrl");`
`pm.environment.unset("key")`	現在(げんざい) 選択(せんたく) 中(ちゅう) の Environment	環境(かんきょう) 変数(へんすう) を削除(さくじょ)	`pm.environment.unset("baseUrl");`

異(こと) なる Collection が同(おな) じ Environment を使用(しよう) すると変数(へんすう) を共有(きょうゆう) し、汚染(おせん) の可能性(かのうせい) がある

Global 変数（Collection を跨いで、グローバルに共用可能）

メソッド / 属性(ぞくせい)	範囲(はんい) / 適用(てきよう)	用途(ようと)	例(れい)
`pm.globals.set("key", value)`	すべての Collection で使用(しよう) 可能(かのう)	Collection を跨(また) いで共有(きょうゆう) する値(あたい) を保存(ほぞん)	`pm.globals.set("token", "abc");`
`pm.globals.get("key")`	すべての Collection	グローバル変数(へんすう) を読(よ) み取(と) る	`let t = pm.globals.get("token");`
`pm.globals.unset("key")`	すべての Collection	グローバル変数(へんすう) を削除(さくじょ)	`pm.globals.unset("token");`

どの Collection からも読(よ) み書(か) き可能(かのう) → 汚染(おせん) リスクが高(たか) い

その他の共通 pm.* メソッド

Request 情報

メソッド / 属性(ぞくせい)	用途(ようと)	例(れい)
`pm.request`	現在(げんざい) の Request を取得(しゅとく) /変更(へんこう)	`pm.request.headers.add({key:"X-Id", value:"123"});`
`pm.request.url`	URL を取得(しゅとく)	`console.log(pm.request.url.toString());`
`pm.request.method`	HTTP Method を取得(しゅとく)	`console.log(pm.request.method);`

Response 情報

メソッド / 属性(ぞくせい)	用途(ようと)	例(れい)
`pm.response`	Response を取得(しゅとく)	`let data = pm.response.json();`
`pm.response.code`	HTTP Status Code	`pm.expect(pm.response.code).to.eql(200);`
`pm.response.json()`	JSON Body を解析(かいせき)	`let data = pm.response.json();`
`pm.response.headers.get("Header-Name")`	Response Header を取得(しゅとく)	`let h = pm.response.headers.get("Content-Type");`

テスト / 検証

メソッド / 属性(ぞくせい)	用途(ようと)	例(れい)
`pm.test("説明", function(){})`	検証(けんしょう) テストを定義(ていぎ)	`pm.test("status 200", ()=> pm.expect(pm.response.code).to.eql(200));`
`pm.expect(actual).to.eql(expected)`	値(あたい) を検証(けんしょう)	`pm.expect(pm.response.json().statusCode).to.eql(0);`
`pm.expect.fail("メッセージ")`	テストを強制(きょうせい) 失敗(しっぱい)	`pm.expect.fail("C failed");`

フロー制御

メソッド / 属性(ぞくせい)	用途(ようと)	例(れい)
`postman.setNextRequest("Request Name")`	Collection Runner で次(つぎ) の Request を制御(せいぎょ)	`postman.setNextRequest("D");`
`throw new Error("メッセージ")`	Request 実行(じっこう) を中断(ちゅうだん)	`throw new Error("Skip D because C failed");`

Console / Debug

メソッド / 属性(ぞくせい)	用途(ようと)	例(れい)
`console.log()`	情報(じょうほう) を出力(しゅつりょく)	`console.log(pm.response.json());`
`console.warn()`	警告(けいこく) メッセージ	`console.warn("prevId not found");`
`console.error()`	エラーメッセージ	`console.error("Request failed");`

Iteration / Data

メソッド / 属性(ぞくせい)	用途(ようと)	例(れい)
`pm.iterationData.get("key")`	Collection Runner の単一(たんいつ) イテレーション	`let username = pm.iterationData.get("user");`
`pm.info.iteration`	現在(げんざい) のイテレーション回数(かいすう) を取得(しゅとく)	`console.log(pm.info.iteration);`
`pm.info.requestName`	現在(げんざい) の Request 名(めい) を取得(しゅとく)	`console.log(pm.info.requestName);`

推奨使用戦略

**安全(あんぜん) 、Collection 内(ない) のみで使用(しよう) ** → Collection 変数(へんすう) (pm.variables)
異(こと) なる環境(かんきょう) （Dev/Prod）向(む) け → Environment 変数(へんすう) (pm.environment)
**Collection を跨(また) いで共有(きょうゆう) ** → Global 変数(へんすう) (pm.globals)、汚染(おせん) を避(さ) けるためできるだけ使用(しよう) を控(ひか) える