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

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

Предварительные требования

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

Для работы с этим руководством вам потребуется приложение, которое вызывает API. Кроме того, необходимо знать URL-адреса ИНТЕРФЕЙСов API, вызываемых приложением.

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

JavaScript

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

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

.NET

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

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

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

Другое

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

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

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

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

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

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

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

```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

Важно!

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

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

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

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

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

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

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

Совет

Установите расширение Dev Proxy Toolkit для Visual Studio Code что упрощает создание и обновление файлов конфигурации.

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

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

Ознакомьтесь с практическими руководствами