MockRequestPlugin(モックリクエストプラグイン)

開発プロキシを使用して Web 要求を発行できます。 このプラグインは、webhook 通知などの要求をシミュレートするのに便利です。

構成された要求を発行するには、開発プロキシが実行されているコマンド プロンプト セッションで w を押します。

2 つに分割されたコマンド プロンプトのスクリーンショット。上部には、Web 要求を発行する開発プロキシが示されています。下部には、要求を受け取り、要求本文を出力する API が示されています。

構成の例

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v3.3.1/rc.schema.json",
  "plugins": [
    {
      "name": "MockRequestPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "contosoNotification"
    }
  ],
  "contosoNotification": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v3.3.1/mockrequestplugin.schema.json",
    "mockFile": "mock-request.json"
  }
}

構成プロパティ

財産 形容 デフォルト
mockFile モック要求を含むファイルへのパス mock-request.json

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

何一つ

モック要求ファイルの例

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v3.3.1/mockrequestplugin.mockfile.schema.json",
  "request": {
    "url": "http://localhost:3000/api/notification",
    "method": "POST",
    "body": {
      "property1": "value1",
      "property2": "value2"
    }
  }
}

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

財産 形容 必須
request 開発プロキシが発行する要求を定義します。 はい

モック要求のプロパティ

財産 形容 必須 デフォルト
url 開発プロキシが呼び出す URL。 はい 空
method 開発プロキシで使用する必要がある HTTP メソッド。 いいえ POST
body 開発プロキシが送信する要求の本文。 いいえ 空
headers Dev Proxy が要求と共に送信する要求ヘッダーの配列。 いいえ 空

文字列または JSON オブジェクトへの body を構成できます。

モック要求ヘッダー

財産 形容 必須
name 要求ヘッダー名。 はい
value 要求ヘッダー値。 はい