MockResponseプラグイン

応答をシミュレートします。

プラグイン インスタンスの定義

{
  "name": "MockResponsePlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "mocksPlugin"
}

構成の例

{
  "mocksPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.29.1/mockresponseplugin.schema.json",
    "mocksFile": "mocks.json"
  }
}

構成プロパティ

コマンドライン オプション

モック ファイルの例

モック オブジェクトの例を次に示します。

本文で応答する

200 OK 応答と JSON 本文を含む要求への応答。

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.29.1/mockresponseplugin.mocksfile.schema.json",
  "mocks": [
    {
      "request": {
        "url": "https://graph.microsoft.com/v1.0/me",
        "method": "GET"
      },
      "response": {
        "body": {
          "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/$entity",
          "businessPhones": ["+1 412 555 0109"],
          "displayName": "Megan Bowen",
          "givenName": "Megan",
          "jobTitle": "Auditor",
          "mail": "MeganB@M365x214355.onmicrosoft.com",
          "mobilePhone": null,
          "officeLocation": "12/1110",
          "preferredLanguage": "en-US",
          "surname": "Bowen",
          "userPrincipalName": "MeganB@M365x214355.onmicrosoft.com",
          "id": "48d31887-5fad-4d73-a9f5-3c356e68a038"
        },
        "headers": [
          {
            "name": "content-type",
            "value": "application/json; odata.metadata=minimal"
          }
        ]
      }
    }
  ]
}

エラーで応答する

404 Not Found 応答で要求に応答します。

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.29.1/mockresponseplugin.mocksfile.schema.json",
  "mocks": [
    {
      "request": {
        "url": "https://graph.microsoft.com/v1.0/me/photo",
        "method": "GET"
      },
      "response": {
        "statusCode": 404
      }
    }
  ]
}

バイナリ データで応答する

ディスク上のファイルから読み込まれたバイナリ イメージを使用して要求に応答します。

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.29.1/mockresponseplugin.mocksfile.schema.json",
  "mocks": [
    {
      "request": {
        "url": "https://graph.microsoft.com/v1.0/users/*/photo/$value",
        "method": "GET"
      },
      "response": {
        "body": "@picture.jpg",
        "headers": [
          {
            "name": "content-type",
            "value": "image/jpeg"
          }
        ]
      }
    }
  ]
}

nth要求で応答する

2 回目に呼び出された後にのみ、要求に応答します。

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.29.1/mockresponseplugin.mocksfile.schema.json",
  "mocks": [
    {
      "request": {
        "url": "https://graph.microsoft.com/v1.0/external/connections/*/operations/*",
        "method": "GET",
        "nth": 2
      },
      "response": {
        "statusCode": 200,
        "body": {
          "id": "1.neu.0278337E599FC8DBF5607ED12CF463E4.6410CCF8F6DB8758539FB58EB56BF8DC",
          "status": "completed",
          "error": null
        }
      }
    }
  ]
}

要求本文に一致する応答

本文に特定の文字列を含む要求に応答します。

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.29.1/mockresponseplugin.mocksfile.schema.json",
  "mocks": [
    {
      "request": {
        "url": "https://login.microsoftonline.com/fa15d692-e9c7-4460-a743-29f29522229/oauth2/v2.0/token",
        "method": "POST",
        "bodyFragment": "scope=https%3A%2F%2Fapi.contoso.com%2FDocuments.Read"
      },
      "response": {
        "headers": [
          {
            "name": "Content-Type",
            "value": "application/json; charset=utf-8"
          }
        ],
        "body": {
          "token_type": "Bearer",
          "expires_in": 3599,
          "ext_expires_in": 3599,
          "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU..."
        }
      }
    }
  ]
}

モック ファイルのプロパティ

Request オブジェクト

各要求には、次のプロパティがあります。

注釈

URL 内の任意の一連の文字と一致させる場合は、* プロパティでアスタリスク (url) を使用します。 たとえば、https://jsonplaceholder.typicode.com/* は https://jsonplaceholder.typicode.com/posts および https://jsonplaceholder.typicode.com/comments と一致します。 実行時に、開発プロキシは各 * を正規表現 .*に変換します。

モックを定義するときは、最も具体的なモックを最初に配置します。 たとえば、2 つのモック (1 つは https://jsonplaceholder.typicode.com/posts 用、1 つは https://jsonplaceholder.typicode.com/*用) がある場合は、最初のモックを最初に配置します。 それ以外の場合、開発プロキシは最初に 2 番目のモックと一致し、すべての要求に対する https://jsonplaceholder.typicode.com/* の応答を返します。

同じ要求 URL に別の要求を送信する必要がある場合は、 nth プロパティを使用します。 たとえば、実行時間の長い操作をシミュレートするために使用します。 API を初めて呼び出すと、 inprogress メッセージを含む応答が返されます。 2 回目に API を呼び出すと、 completed メッセージを含む応答が返されます。 nth プロパティの詳細については、「モック n 番目の要求」を参照してください。

bodyFragment プロパティを使用すると、本文の内容に基づいて要求を照合できます。 たとえば、本文に foo 文字列を含む要求を照合する場合は、 bodyFragment プロパティを foo に設定します。 開発プロキシは、bodyFragment以外の要求にのみGETを使用します。

Response オブジェクト

各応答には、次のプロパティがあります。

注釈

バイナリ データを返す場合は、 body プロパティを、 @ で始まる文字列値に設定し、その後にモック ファイルを基準にしたファイル パスを指定します。 たとえば、 @picture.jpg はモック ファイルと同じディレクトリ内の picture.jpg ファイルに格納されているイメージを返します。

次のステップ