Поделиться через

Настройка прокси-сервера разработки

  • Статья

Прокси Dev обладает высокой настраиваемостью. Он использует подключаемые модули для реализации функциональных возможностей. Вы можете объединить любые из стандартных подключаемых модулей , и , чтобы создать собственный. С помощью подключаемых модулей и пользовательских конфигураций вы можете настроить прокси-сервер разработки в соответствии с вашими потребностями. Прокси-сервер разработки включает файл конфигурации по умолчанию с именем devproxyrc.json. Файл находится в папке установки Dev Proxy.

Совет

Рекомендуется создавать пользовательские файлы конфигурации. С помощью пользовательских файлов конфигурации можно легко переключаться между различными конфигурациями и включать их в систему управления версиями вместе с кодом проекта. Хранение конфигурации в проекте также упрощает совместное использование конфигурации с командой.

Если вы назовете файл конфигурации devproxyrc.json или devproxyrc.jsonc, сервер разработки автоматически загружает его из текущего каталога при запуске. Для других имен укажите путь к файлу в аргументе --config-file при запуске Dev Proxy, например devproxy --config-file ./my-devproxy-config.json.

Структура файла конфигурации

В следующем фрагменте кода показан файл конфигурации прокси-сервера разработки по умолчанию:

{
  "$schema": "https://raw.githubusercontent.com/microsoft/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. Чтобы убедиться, что файл конфигурации действителен, обязательно используйте ту же версию схемы, что и используемую версию прокси-сервера разработки.
  • Список подключаемых модулей, которые использует Dev Proxy, определенные в массиве plugins.
  • Общие параметры конфигурации .

Важный

Прокси-сервер разработки применяет подключаемые модули в том порядке, в котором они перечислены в файле конфигурации. Обратите внимание на порядок, чтобы добиться желаемого поведения.

Некоторые плагины настраиваются и предоставляют собственные параметры. Каждый подключаемый модуль имеет собственный раздел конфигурации в файле конфигурации, на который ссылается свойство configSection в определении подключаемого модуля. Дополнительные сведения о параметрах конфигурации см. в справочной документации для каждого подключаемого модуля.

Совет

Значение свойства configSection может быть любой строкой. Используя разные имена, можно включить несколько экземпляров одного подключаемого модуля, каждый из которых имеет другую конфигурацию. Может потребоваться несколько раз использовать один и тот же подключаемый модуль, например, при имитации нескольких API с различными ошибками и поведением.

Набор инструментов прокси разработки

Dev Proxy Toolkit — это расширение Visual Studio Code, которое значительно упрощает настройку Dev Proxy. Ниже приведены некоторые функции, которые он включает в себя:

  • Фрагменты кода для распространенных сценариев конфигурации
  • расширенная проверка кода и IntelliSense для файлов конфигурации прокси, используемого в разработке.
  • Пользовательские действия и команды редактора для удобного запуска и остановки прокси-сервера разработки
  • уведомления о новых версиях Dev Proxy (прокси-сервера разработки)

Совет

Если вы используете Visual Studio Code, мы настоятельно рекомендуем установить расширение Dev Proxy Toolkit.

Следующий шаг

Если вы хотите продолжить изучение использования прокси-сервера разработки, ознакомьтесь со следующими руководствами.

В противном случае ознакомьтесь с нашими инструкциями , чтобы узнать, как использовать прокси-сервер разработки для конкретных ситуаций.