本文へスキップ
←  ホーム English

モックルール

基本概念

Mimicry では、モックルールを階層構造で管理します。

モックルールのフォルダ構造。プロジェクト、フォルダ、ルールの階層構造がツリービューで表示されている
プロジェクト- 最上位の管理単位(例:MyApp)
フォルダ- ルールをグループ化(例:Users API)
ルール- 個別のモックルール

各ルールには有効/無効の切り替えがあり、無効にするとそのルールは適用されなくなります。

ルールの作成

モックルール編集画面。URLパターン、HTTPメソッド、ステータスコード、レスポンスボディの設定フィールドが表示されている
1

左サイドバーでルールを追加するフォルダを選択します。

2

URL パターン、HTTP メソッド、レスポンスを設定します。

3

保存 ボタンをクリックしてルールを保存します。

4

ルールが有効になっていることを確認します(トグルスイッチ)。

設定項目

URL パターン

リクエスト URL にマッチするパターンを指定します。ワイルドカード(*、**)を使用できます。

# 完全一致
https://api.example.com/users

# 1 セグメントのワイルドカード
https://api.example.com/users/*

# 複数セグメントのワイルドカード
https://api.example.com/**

# ホストを問わず、パスだけで指定する
/api/users/**

# ドメインのワイルドカード
https://*.example.com/api/*
  • http:// か https:// から書くと、ホストを含む URL 全体を照合します。/ から書くと、ホストを問わずパス (とクエリ) だけを照合します。
  • * は / を越えません。/ を越えて複数のセグメントにマッチさせるには ** を使います。
  • パスは全体が一致する必要があり、前方一致ではありません。/api/users/* は /api/users/42 にマッチしますが、/api/users/42/posts にはマッチしません。
  • 末尾のスラッシュは区別されます。/api/users と /api/users/ は別のパスです。
  • 大文字小文字は、ASCII の文字だけ無視されます。
  • クエリは、パターンに書いたときだけ照合し、書いたパラメータがリクエストに含まれていれば一致します (部分集合)。パターンにクエリがなければ、リクエストのクエリは無視されます。

HTTP メソッド

マッチする HTTP メソッドを指定します。

すべてのメソッドGETPOSTPUTPATCHDELETEHEADOPTIONS

「すべてのメソッド」を選択するとすべての HTTP メソッドにマッチします。

ステータスコード

レスポンスのステータスコードを指定します。よく使うコードはプリセットから選択でき、末尾の「カスタム」を選ぶと 100〜599 の任意のコードを直接入力できます。

200OK
201Created
204No Content
301Moved Permanently
302Found
400Bad Request
401Unauthorized
403Forbidden
404Not Found
500Internal Server Error
502Bad Gateway
503Service Unavailable

レスポンスヘッダー

レスポンスヘッダーを JSON 形式で指定します。

{
  "Content-Type": "application/json",
  "Cache-Control": "no-cache"
}

レスポンスボディ

レスポンスボディを設定します。JSON、テキスト、HTML など任意の形式で指定できます。

{
  "id": 1,
  "name": "John Doe",
  "email": "john@example.com"
}

遅延 (ミリ秒)

レスポンスを返すまでの遅延時間をミリ秒で指定します。ネットワーク遅延やタイムアウト処理のテストに使用します。

例:050020005000

プロジェクト・フォルダ管理

プロジェクト・フォルダの作成

左サイドバー上部の + ボタンからプロジェクトまたはフォルダを作成できます。

ルールの複製

既存のルールを複製して、似たようなルールを効率的に作成できます。

  1. 複製したいルールを右クリック
  2. 「複製」を選択
  3. 同じ設定のルールが作成される

URL パターンやレスポンスが似ているルールを複数作成する場合に便利です。

ドラッグ & ドロップ

ルールやフォルダはドラッグ&ドロップで並び替えができます。複数のプロジェクト間でルールを移動することも可能です。

有効/無効の切り替え

各ルールには有効/無効のトグルスイッチがあります。無効にしたルールはリクエストにマッチしません。

ルールの優先順位

複数のルールがマッチする場合、リストの上にあるルールが優先されます。

ヒント: より具体的なルール(完全一致など)を上に、汎用的なルール(ワイルドカード)を下に配置することをお勧めします。

CLI が --project を指定して書き込んだプロジェクトは、サイドバーでの並び順に関係なく、ほかのプロジェクトより先に照合されます (ピン留め)。ピン留めは、サイドバーの PIN バッジか右クリックメニューから解除できます。

一時ルール

CLI の rule set に --ttl を付けると、指定した時間が過ぎたときにルールが自動で削除されます。--times を付けると、N 回適用したあとに自動で削除されます。適用した回数は、mimicry logs --json の ruleUse で確認できます。GUI のサイドバーには「一時 · 残り …」のバッジが表示され、「常設にする」で残せます。