执行摘要插件 (ExecutionSummaryPlugin)

创建通过代理的请求的摘要。

提示

在配置中使用记者插件将摘要保存到文件中。

命令提示符的屏幕截图,其中显示了开发代理执行摘要,其中包含有关已截获的请求的信息。

命令提示符的屏幕截图,其中包含开发人员代理截获的请求摘要。

配置示例

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "ExecutionSummaryPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "executionSummaryPlugin"
    }
  ],
  "executionSummaryPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/executionsummaryplugin.schema.json",
    "groupBy": "url"
  }
}

配置属性

properties 说明 默认
groupBy 代理应如何对摘要中的信息进行分组。 可用选项:url、messageType url

命令行选项

名称 说明 默认
--summary-group-by 代理应如何对摘要中的信息进行分组。 可用选项:url、messageType url

Output

停止录制时,ExecutionSummaryPlugin 会创建其报表。 若要将报表另存为 JSON,请在配置中的 ExecutionSummaryPlugin 后面添加 JsonReporter 。 JsonReporter 将报表写入当前工作目录中名为 ExecutionSummaryPlugin_JsonReporter.json 的文件。 如果文件已存在,则开发代理会将时间戳追加到文件名中,例如 ExecutionSummaryPlugin_JsonReporter_20261105104151.json。

JSON 报表是嵌套三个级别的对象。 最内部级别的值是显示开发代理记录消息次数的数字。 每个级别的含义取决于 groupBy 设置。

开发代理在报表中使用以下可读类别名称:

Category 说明
Requests intercepted 开发代理截获的请求。 仅当 groupBy 为 messageType
Requests passed through 开发代理传递到原始服务器的请求
Requests mocked 插件为其返回模拟响应的请求
Requests with chaos 插件模拟错误或延迟的请求
Failures 失败的请求
Tips 插件为请求记录的提示
Warnings 插件为请求记录的警告
Unknown 为请求记录的其他消息,例如请求时间戳和跳过请求的插件的消息

按 URL 分组

url何时groupBy为报表具有以下形状:

{
  "<method> <url>": {
    "<category>": {
      "<message>": <count>
    }
  }
}
Level 说明
1 例如 GET https://jsonplaceholder.typicode.com/users,每个截获请求的 HTTP 方法和 URL。 无论应用调用它的次数,每个方法和 URL 组合都会显示一次
2 开发代理为请求记录的消息类别
3 开发代理记录的消息,映射到开发代理为方法和 URL 记录它的次数

以下示例显示了调用一次、 GET https://jsonplaceholder.typicode.com/users 开发代理模拟的应用的报表,以及 GET https://jsonplaceholder.typicode.com/posts 两次通过开发代理传递的报告。 为了提高可读性,这些 Unknown 条目会缩短。

{
  "GET https://jsonplaceholder.typicode.com/users": {
    "Unknown": {
      "2026-11-05T10:41:13.1151430+00:00": 1,
      "GET https://jsonplaceholder.typicode.com/users": 1
    },
    "Requests mocked": {
      "200 https://jsonplaceholder.typicode.com/users": 1
    }
  },
  "GET https://jsonplaceholder.typicode.com/posts": {
    "Unknown": {
      "No matching mock response found": 2,
      "GET https://jsonplaceholder.typicode.com/posts": 2
    },
    "Requests passed through": {
      "Passed through": 2
    }
  }
}

按消息类型分组

messageType何时groupBy为报表具有以下形状:

{
  "<category>": {
    "<message>": {
      "<method> <url>": <count>
    }
  }
}
Level 说明
1 开发代理记录的消息类别
2 开发代理记录的消息。 Requests intercepted对于类别和Requests passed through类别,此级别重复类别名称
3 请求的 HTTP 方法和 URL,映射到开发人员代理记录该方法和 URL 的消息的次数

以下示例显示了按消息类型分组的相同请求的报告。 为了提高可读性,将 Unknown 缩短类别。

{
  "Requests intercepted": {
    "Requests intercepted": {
      "GET https://jsonplaceholder.typicode.com/users": 1,
      "GET https://jsonplaceholder.typicode.com/posts": 2
    }
  },
  "Unknown": {
    "No matching mock response found": {
      "GET https://jsonplaceholder.typicode.com/posts": 2
    }
  },
  "Requests mocked": {
    "200 https://jsonplaceholder.typicode.com/users": {
      "GET https://jsonplaceholder.typicode.com/users": 1
    }
  },
  "Requests passed through": {
    "Requests passed through": {
      "GET https://jsonplaceholder.typicode.com/posts": 2
    }
  }
}

提示

若要签入请求开发代理截获的 CI 管道,请使用 messageType 分组并读取对象的密钥 ["Requests intercepted"]["Requests intercepted"] 。 使用 url 分组,读取顶级键。 每个密钥都以 HTTP 方法开头,后跟一个空格和 URL。 不要依赖于类别的内容 Unknown ,因为它包含时间戳和其他诊断消息。

另请参阅

后续步骤