通过

配置开发代理

开发代理为高度可配置。 它使用 插件 来实现功能。 可组合任何标准插件并生成自己的插件。 通过使用插件和自定义配置，可以根据特定需求定制开发代理。 开发代理包括名为 devproxyrc.json的默认配置文件。 该文件位于开发代理的安装文件夹中。

提示

建议创建自定义配置文件。 通过使用自定义配置文件，可以在不同的配置之间轻松切换，并且可以将它们包含在源代码管理系统中，以及项目的代码。 将配置与项目一起存储还可以更轻松地与团队共享配置。

如果将配置文件命名为 devproxyrc.json 或 devproxyrc.jsonc，则启动配置文件时，开发代理会自动从当前目录中加载它。 对于其他名称，请在启动开发代理时在 --config-file 参数中指定文件路径，例如 devproxy --config-file ./my-devproxy-config.json。

配置文件结构

以下代码片段显示了默认的开发代理配置文件：

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.24.0/rc.schema.json",
  "plugins": [
    {
      "name": "RetryAfterPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll"
    },
    {
      "name": "GenericRandomErrorPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
      "configSection": "genericRandomErrorPlugin"
    }
  ],
  "urlsToWatch": [
    "https://jsonplaceholder.typicode.com/*"
  ],
  "genericRandomErrorPlugin": {
    "errorsFile": "devproxy-errors.json"
  },
  "rate": 50,
  "logLevel": "information",
  "newVersionNotification": "stable",
  "showSkipMessages": true,
  "showTimestamps": true
}

配置文件由三个部分组成：

  • 架构，在 $schema 属性中定义。 若要确保配置文件有效，请确保使用与所使用的开发代理版本相同的架构版本。
  • 开发代理使用的插件列表，在 plugins 数组中定义。
  • 常规配置设置。

重要

Dev Proxy 按它们在配置文件中列出的顺序应用插件。 注意获取所需行为的顺序。

某些插件可配置并公开其自己的设置。 每个插件在配置文件中都有自己的配置部分，由插件定义中的 configSection 属性引用。 请参阅每个插件的参考文档，了解有关其配置选项的详细信息。

提示

configSection 属性的值可以是任何字符串。 通过使用不同的名称，可以包含同一插件的多个实例，每个实例都有不同的配置。 例如，模拟具有不同错误响应和行为的多个 API 时，可能需要多次引用同一插件。

开发者代理工具包

开发代理工具包 是一个 Visual Studio Code 扩展，可显著简化开发代理配置。 以下是它包括的一些功能：

  • 常见配置方案的代码片段
  • 适用于开发代理配置文件的扩展 Lint 分析和 IntelliSense
  • 自定义编辑器操作和命令，方便启动和停止开发代理服务器
  • 关于开发代理新版本的通知

提示

如果你使用 Visual Studio Code，我们强烈建议你安装开发代理工具包扩展。

下一步

若要继续了解如何使用开发代理，请考虑以下教程：

否则，请查看我们的 操作指南 ，以学习如何在特定场景下使用Dev Proxy。