Имитация случайных ошибок для собственного приложения

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

Необходимые условия

В этой части руководства предполагается, что на компьютере установлен и настроен прокси-сервер разработки. Если нет, сделайте это сейчас.

Чтобы следовать этому руководству, вам потребуется приложение, которое вызывает API. Кроме того, необходимо знать URL-адреса API, которые вызывает приложение.

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

JavaScript

Использование прокси-сервера разработки с помощью:

• Node.js приложения
• приложения Node.js в Docker
• Функции Azure JavaScript
• решения SharePoint Framework (SPFx)

.СЕТЬ

Использование прокси-сервера разработки с помощью:

• приложения .NET
• приложения .NET в Docker
• приложения .NET Aspire

Если вы используете Dev Proxy с приложением .NET 4.8, необходимо зарегистрировать Dev Proxy в системе используя netsh.

Другие

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

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

Запуск прокси-сервера разработки с мониторингом URL-адресов

Запустите прокси-сервер разработки и отслеживайте URL-адреса API, которые вызывает приложение. Например, если приложение вызывает API, расположенный в https://api.contoso.com/v1/customers, запустите прокси-сервер разработки и отслеживайте шаблон URL-адреса https://api.contoso.com/*.

devproxy --urls-to-watch "https://api.contoso.com/*"

Параметр --urls-to-watch сообщает Dev Proxy, какие запросы перехватывать. Подстановочный знак * в конце URL-адреса сообщает Dev Proxy перехватывать все запросы на URL-адреса, начинающиеся с https://api.contoso.com/.

Начните использовать приложение, как обычно. Прокси-сервер разработки перехватывает все запросы на указанные URL-адреса. В командной строке отображаются сообщения о запросах, которые перехватывает Dev Proxy.

```text
 request     GET https://api.contoso.com/v1/customers
     api   ╭ Passed through
           ╰ GET https://api.contoso.com/v1/customers
 request     GET https://api.contoso.com/v1/customers
   chaos   ╭ 403 Forbidden
           ╰ GET https://api.contoso.com/v1/customers

Важный

Если в командной строке нет сообщений, убедитесь, что приложение правильно настроено для использования прокси-сервера разработки. Кроме того, проверьте, перехватывает ли Dev Proxy запросы к URL-адресам API, которые использует ваше приложение. Если у вас есть вопросы, обратитесь за помощью в сообществе Dev Proxy на Discord.

Создание собственных файлов конфигурации

По умолчанию в прокси-сервере разработки используется файл devproxyrc.json в папке установки прокси-сервера разработки для параметров конфигурации. Файл настроен для имитации случайных ошибок для API заполнителя JSON. Чтобы получить более реалистичные результаты, создайте собственные файлы конфигурации с ошибками, которые более важны для приложения и используемых API, и используйте их с прокси-сервером разработки.

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

1. В папке установки прокси-сервера разработки скопируйте devproxyrc.json и devproxy-errors.json.
2. В папку проекта вставьте файлы.

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

1. В текстовом редакторе откройте файл devproxyrc.json.
2. Найдите плагин GenericRandomErrorPlugin в массиве plugins.
3. Обновите pluginPath до ~appFolder/plugins/DevProxy.Plugins.dll.
4. Найдите плагин RetryAfterPlugin в массиве plugins.
5. Обновите pluginPath до ~appFolder/plugins/DevProxy.Plugins.dll.
6. В командной строке измените рабочий каталог на папку проекта.
7. Введите devproxy --config-file devproxyrc.json и нажмите . Введите, чтобы запустить Dev Proxy, используя ваш файл конфигурации.
8. Отправьте запрос в API заполнителя JSON из командной строки и просмотрите выходные данные.
9. Чтобы безопасно остановить прокси-сервер разработки, нажмите клавиши CTRL + C.

Совет

Установите расширение для Visual Studio Code «Набор средств разработки прокси-сервера», который упрощает создание и обновление файлов конфигурации.

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

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

Исследуйте инструкции по выполнению