スクリプトを使用したリクエストメッセージの変更

pm.requestを使用してリクエストメッセージの読み取りや変更ができる。

スクリプトですべてのリクエストパラメータを取得できるが、ヘッダーとクエリパラメータの変更のみ可能。

ヘッダーとクエリパラメータの変更は前処理スクリプトでのみ有効で、後処理スクリプトでは無効。

スクリプトでAPIパラメータを取得する場合：パラメータに変数が含まれていると、対応する値に置き換えられない。実際の値を取得するにはpm.variables.replaceInを使用する必要がある。

// pm.variables.replaceIn：パラメータ内の変数の処理
var body = pm.variables.replaceIn(pm.request.body.raw);
var jsonData = JSON.parse(body);

TIP

Apidogの前処理には、「変数置換」という組み込みの前処理があり、リクエスト内のすべての変数（動的変数を含む）を実際の値に置き換える。

変数設定などのスクリプトは、変数が正常に設定されるように変数置換の前に配置する必要がある。

API署名などのスクリプトは、パラメータの実際の値を取得するために変数置換の後にドラッグする必要がある。

URL関連情報

Headerパラメータ

ヘッダーパラメータの取得

ヘッダーパラメータの変更

Queryパラメータ

クエリパラメータの取得

クエリパラメータの変更

Bodyパラメータ

ボディパラメータはpm.request.bodyから取得され、RequestBodyインスタンスとなる。

詳細はこちらを参照。

TIP

ボディデータを変更するには、Bodyで変数を参照することを推奨する。前処理スクリプトで対応する変数の値を変更できる。

Apidogバージョン1.4.16以上では、ボディパラメータの直接変更をサポートしている。使用例は以下の通り：

var body = pm.request.body.toJSON();
console.log("bodyオブジェクト", body);

var bodyStr = body.raw;
console.log("body文字列", bodyStr);

var bodyJSON = JSON.parse(bodyStr);
bodyJSON.id = 100;
pm.request.body.update(JSON.stringify(bodyJSON, null, 2));
console.log("変更されたbody", pm.request.body.toJSON());

1. ボディタイプ：form-data

form-dataの情報を取得

2. ボディタイプ：x-www-form-urlencode

x-www-form-urlencodeの情報を取得

3. ボディタイプ：JSON

JSON情報を取得

4. ボディタイプ：raw

raw情報を取得

スクリプトを使用したリクエストメッセージの変更

URL関連情報#

Headerパラメータ#

Queryパラメータ#

Bodyパラメータ#

1. ボディタイプ：form-data#

2. ボディタイプ：x-www-form-urlencode#

3. ボディタイプ：JSON#

4. ボディタイプ：raw#