UrlDiscovery插件

创建开发代理截获的 URL 列表。 使用此插件可了解应用正在调用哪些 URL 以及如何配置开发代理来模拟这些 URL 的行为。

提示

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

拆分命令提示符窗口的屏幕截图。在左侧,显示已截获请求的开发代理输出。在右侧,生成了包含已截获 URL 的报告。

配置示例

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

配置属性

没有

Output

UrlDiscoveryPlugin 会在停止录制时创建其报表。 报告包含开发代理截获的请求的唯一 URL,按字母顺序排序。 每个 URL 都是完整的请求 URL,包括其查询字符串。

若要将报表另存为 JSON,请在配置中的 UrlDiscoveryPlugin 后面添加 JsonReporter 。 JsonReporter 将报表写入当前工作目录中名为 UrlDiscoveryPlugin_JsonReporter.jsonc 的文件。 如果文件已存在,则开发代理会将时间戳追加到文件名中,例如 UrlDiscoveryPlugin_JsonReporter_20261105104151.jsonc。

该文件是一个 JSON,其中包含注释 (JSONC) 文件,可以将其用作开发代理配置中的属性的起点 urlsToWatch 。 该文件包含注释,说明如何使用通配符和排除 URL,后跟 urlsToWatch 包含截获 URL 的数组:

{
  // Wildcards
  // 
  // You can use wildcards to catch multiple URLs with the same pattern.
  // For example, you can use the following URL pattern to catch all API requests to
  // JSON Placeholder API:
  // 
  // https://jsonplaceholder.typicode.com/*
  // 
  // Excluding URLs
  // 
  // You can exclude URLs with ! to prevent them from being intercepted.
  // For example, you can exclude the URL https://jsonplaceholder.typicode.com/authors
  // by using the following URL pattern:
  // 
  // !https://jsonplaceholder.typicode.com/authors
  // https://jsonplaceholder.typicode.com/*
  "urlsToWatch": [
    "https://jsonplaceholder.typicode.com/posts",
    "https://jsonplaceholder.typicode.com/users",
    "https://jsonplaceholder.typicode.com/users/1"
  ]
}
属性 Description
urlsToWatch 字符串数组。 开发代理在录制时截获的请求的唯一 URL,按字母顺序排序。 URL 不包含通配符

Important

由于该文件包含注释,因此标准 JSON 分析程序(如 JSON.parse JavaScript 中)或 jq无法分析它。 若要在脚本中读取文件,请使用支持注释(例如 JSON5 或 jsonc-parser npm 包)分析程序,或在分析文件之前去除注释行。

另请参阅

后续步骤