モックスクリプト

モックスクリプトを使用すると、リクエストパラメータとレスポンスデータの間に論理的な関係を持つ、インテリジェントなモックレスポンスを作成できます。この機能は、文脈上の正確性を維持するモックデータや、リクエスト値を反映するモックデータが必要な場合に不可欠です。

ユースケース

モックスクリプトは、論理的なデータ関係が必要なシナリオに最適です。

一般的な例

リクエストされた ID と一致するユーザー ID をレスポンスで返す（例: リクエスト ID 1001 → レスポンスに ID 1001 を含める）

時間的な整合性を確保する（例: 終了時刻は常に開始時刻より後になる）

関連フィールドを計算する（例: 数量と単価に基づく合計価格）

リクエストパラメータをレスポンスペイロードに反映する

モックスクリプトの仕組み

モックスクリプトは、5 つのステップのワークフローでデータを処理します。

Smart mock またはその他のモック機能が初期レスポンスを生成します

モックスクリプトが $$.mockResponse オブジェクトと $$.mockRequest オブジェクトにアクセスします

JavaScript ロジックがこれらのオブジェクトからデータを取得して処理します

$$.mockResponse.setBody メソッドが、変更されたデータでレスポンスを更新します

モックエンジンが最終的に処理されたレスポンスを返します

モックスクリプトは Smart mock でのみ動作します。モック期待値やレスポンス例には適用されません。

モックスクリプトの使用

スクリプトの有効化と作成

下部に Mock Script セクションが表示される Mock タブに移動します

スクリプトのスイッチをオンにします

エディタでスクリプトを記述して保存します

スクリプトリファレンス

基本例

このスクリプトが行うこと:

自動生成された初期モックレスポンスを取得します

次の方法でレスポンスを変更します。

page をリクエストされた page パラメータと一致するように設定します

total に固定値 120 を設定します

これらの変更でモックレスポンスを更新します

`$$.mockRequest` オブジェクト

$$.mockRequest オブジェクトは、受信リクエストを表します。これは Postman の pm.request オブジェクトに似ていますが、追加機能があります。

主なメソッド:

メソッド/プロパティ	説明
`getParam(key)`	任意の場所（query、body など）からパラメータを取得します
`headers`	HTTP ヘッダーにアクセスします
`cookies`	Cookie 値にアクセスします
`body`	リクエストボディにアクセスします
`formdata`	form-data パラメータにアクセスします
`urlencoded`	URL エンコードされたパラメータにアクセスします

使用例:

`$$.mockResponse` オブジェクト

$$.mockResponse オブジェクトは、返送されるレスポンスを表します。これは Postman の pm.response オブジェクトに似ていますが、追加の制御メソッドがあります。

主なメソッド:

メソッド	パラメータ	説明
`setBody(body)`	any	レスポンスボディを設定します
`setCode(code)`	number	HTTP ステータスコードを設定します
`setDelay(duration)`	number (ms)	レスポンス遅延を追加します（レイテンシをシミュレートします）
`json()`	-	レスポンスを JSON として取得します
`headers`	-	レスポンスヘッダーにアクセス/変更します

使用例:

FAQ

Q: モックスクリプトで Apidog 変数を使用するにはどうすればよいですか？

A: モックスクリプトでは Apidog 変数を使用できません。

変数は Apidog クライアントの機能ですが、モックエンジンは独立して実行されるため、クライアント側の変数にアクセスできません。

Q: モックスクリプトでログステートメントを使用するにはどうすればよいですか？

A: モックスクリプトは ログ機能を提供していません。

コンソールはクライアント側の機能ですが、モックエンジンは別個に動作するため、クライアントコンソールにログを出力できません。

Q: モックスクリプトで pm オブジェクトを使用できないのはなぜですか？

A: pm オブジェクトは モックスクリプトでは使用できません。

モックスクリプトはモックサーバー上で実行されますが、pre/post スクリプトは Apidog クライアント上で実行されます。これらは、利用可能なオブジェクトと構文が異なる、まったく別の実行環境です。

Q: モックスクリプトはモック期待値で動作しますか？

A: いいえ、モックスクリプトは Smart mock でのみ動作します。

モック期待値に一致した場合、モックスクリプトは実行されません。モックスクリプトはモック期待値やレスポンス例には適用されません。

モックスクリプト

ユースケース#

モックスクリプトの仕組み#

モックスクリプトの使用#

スクリプトの有効化と作成#

スクリプトリファレンス#

基本例#

$$.mockRequest オブジェクト#

$$.mockResponse オブジェクト#

FAQ#

ユースケース

モックスクリプトの仕組み

モックスクリプトの使用

スクリプトの有効化と作成

スクリプトリファレンス

基本例

`$$.mockRequest` オブジェクト

`$$.mockResponse` オブジェクト

FAQ