MockRequest插件

允许使用开发代理发出 Web 请求。 此插件可用于模拟 Webhook 通知等请求。

若要发出配置的请求,请在运行开发代理的命令提示符会话中按 w。

两个命令提示符拆分的屏幕截图。顶部部分显示发出 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 开发代理应随请求一起发送的请求标头数组。 不 空

可以将 body 配置为字符串或 JSON 对象。

模拟请求标头

财产 描述 必填
name 请求标头名称。 是的
value 请求标头值。 是的