Mockスクリプト

特定のリクエストパラメータに対応するモックデータを返したり、異なるプロパティ間の論理的な関係を維持する必要がある場合があります。

例えば：

IDが1001のユーザー情報をリクエストした場合、レスポンスにはこのIDが含まれ、その値は1001であるべきです。

または、モックデータに開始時刻と終了時刻のような関連するプロパティが含まれている場合、終了時刻は開始時刻よりも後であるべきです。

これらの論理的な関係は、Mockスクリプトを使用して実装できます。

仕組み

Mockスクリプトの基本的な実装原理は以下の通りです：

Smart mockやその他のモック機能を使用して、初期のモックレスポンスを生成します。このレスポンスは、必要なすべての制約を満たしていない可能性があります。

Mockスクリプトを使用して、$.mockResponseオブジェクトや$.mockRequestオブジェクトにアクセスします。

mockResponseとmockRequestからデータを取得し、JavaScriptを使用して目的のロジックを実装します。

$.mockResponse.setBodyメソッドを使用して、変更したデータでmockResponseを書き換えます。

モックエンジンが最終的なmockResponseを返します。

Mockスクリプトの使用

Mockタブに切り替え、下部にあるMock Scriptセクションを見つける。

スクリプトのトグルをオンにする。

スクリプトを書いて保存する。

スクリプトリファレンス

Mockスクリプトの例

このスクリプトは以下のことを行います：

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

次に、このレスポンスを修正します：

pageの値をリクエストされた値に合わせます。

totalの値を固定値に設定します。

最後に、これらの変更をモックレスポンスに反映します。

$.mockRequestオブジェクト

$.mockRequestオブジェクトは、Mockスクリプト内で受信したリクエストを表します。Postmanのpm.requestオブジェクトに似ていますが、いくつかの追加機能があります。

getParam(key: string)メソッド: リクエストからパラメータを取得します。パラメータの場所（クエリ文字列、ボディなど）に関係なく取得できます。

クッキーへのアクセス: リクエストからクッキーの値を取得できます。

使用例

$.mockResponseオブジェクト

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

setBody(body: any)メソッド: レスポンスボディを設定します。

setCode(code: number)メソッド: レスポンスのHTTPステータスコードを設定します。

setDelay(duration: number)メソッド: モックレスポンスに遅延を追加し、ネットワークの遅延をシミュレートします。

使用例

FAQ

Q: MockスクリプトでApidogの変数を使用するにはどうすればいいですか？
A: Mockスクリプトでは変数を使用できません。これは、変数がApidogクライアントの機能であるためです。モックエンジンはクライアントの一部ではないため、クライアント内の変数を参照できません。

Q: Mockスクリプトでログステートメントを使用してコンソールに出力するにはどうすればいいですか？
A: Mockスクリプトではログ機能は提供されていません。コンソールはApidogクライアントの機能であるため、モックエンジンはクライアントにログを出力できません。

Q: Mockスクリプトでpmオブジェクトを使用できないのはなぜですか？
A: Mockスクリプトはモックサーバー上で実行されますが、前処理/後処理スクリプトはリクエストを送信するApidogクライアント上で実行されます。これらは完全に異なる環境であるため、スクリプトの構文を共有することはできません。

仕組み#

Mockスクリプトの使用#

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

Mockスクリプトの例#

$.mockRequestオブジェクト#

使用例#

$.mockResponseオブジェクト#