HarGeneratorPlugin

从截获的请求和响应生成 HTTP 存档 (HAR) 文件。

插件实例定义

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

配置示例

{
  "harGeneratorPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.3.0/hargeneratorplugin.schema.json",
    "includeSensitiveInformation": false,
    "includeResponse": true
  }
}

配置属性

资产 Description 违约
includeSensitiveInformation 确定是否在生成的 HAR 文件中包括敏感信息(授权标头、Cookie 等)。 设置为 false时,使用值对敏感标头进行编辑 REDACTED false
includeResponse 确定是否在生成的 HAR 文件中包括响应正文内容 false

命令行选项

None

注解

HAR (HTTP 存档)格式是基于 JSON 的格式,用于记录 HTTP 事务。 各种工具广泛支持它,并使用它:

  • 分析网络流量和性能
  • 调试 API 交互
  • 共享 HTTP 会话数据
  • 导入浏览器开发人员工具和其他分析工具

如果 includeSensitiveInformation 设置为 false,插件会自动对以下敏感标头进行修订:

  • authorization
  • cookie
  • from
  • proxy-authenticate
  • proxy-authorization
  • set-cookie
  • www-authenticate
  • x-api-key
  • x-auth-token
  • x-csrf-token
  • x-forwarded-for
  • x-real-ip
  • x-session-token
  • x-xsrf-token

生成的 HAR 文件包括:

  • HTTP 请求详细信息(方法、URL、标头、查询参数、Cookie)
  • HTTP 响应详细信息(状态、标头、Cookie)
  • 请求和响应正文数据(如果适用)
  • 内容类型和大小
  • HTTP 版本信息

该插件在录制停止后创建一个名为当前目录中的 HAR 文件 devproxy-{timestamp}.har