Технический справочник по Dev Proxy

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

Какой подключаемый модуль следует использовать для создания отчетов и анализа?

Используйте следующую таблицу, чтобы выбрать подключаемый модуль, соответствующий тому, что вы хотите узнать о трафике API приложения. Подключаемые модули, создающие отчет, нуждаются в репортере, например JsonReporter, MarkdownReporter или PlainTextReporter, чтобы сохранить отчет в файл. Подключаемые модули генератора записывают выходной файл напрямую. После остановки записи Dev Proxy создает выходные файлы в текущем рабочем каталоге.

Goal	плагин + средство отчетности	Выходной файл
Проведите инвентаризацию URL-адресов, которые вызывает мое приложение	UrlDiscoveryPlugin + JsonReporter	UrlDiscoveryPlugin_JsonReporter.json
Подсчет запросов и их исходов	ExecutionSummaryPlugin + MarkdownReporter или JsonReporter	ExecutionSummaryPlugin_MarkdownReporter.md или ExecutionSummaryPlugin_JsonReporter.json
Запись полных запросов и ответов	HarGeneratorPlugin	devproxy-yyyyMMddHHmmss.har
Создать воспроизводимые запросы	HttpFileGeneratorPlugin	requests_yyyyMMddHHmmss.http
Создать спецификацию API из трафика	OpenApiSpecGeneratorPlugin или TypeSpecGeneratorPlugin	host-port-yyyyMMddHHmmss.json (или .yaml) на узел API или name-yyyyMMddHHmmss.tsp на узел API
Создание моков из трафика	MockGeneratorPlugin	mocks-yyyyMMddHHmmss.json
Найдите минимальные разрешения, необходимые моему приложению	MinimalPermissionsPlugin + MarkdownReporter или JsonReporter	MinimalPermissionsPlugin_MarkdownReporter.md или MinimalPermissionsPlugin_JsonReporter.json

Note

Если файл отчета с тем же именем уже существует, репортер добавляет метку времени к имени файла, например UrlDiscoveryPlugin_JsonReporter_yyyyMMddHHmmss.json. Для Microsoft Graph API используйте GraphMinimalPermissionsPlugin, чтобы найти минимальные разрешения.

Плагины

Список плагинов, работающих с любым API.

Имя	Описание
AuthPlugin	Имитирует проверку подлинности и авторизацию с помощью ключей API или OAuth2.
DevToolsPlugin	Предоставляет сообщения прокси-сервера разработки и информацию о перехваченных запросах и ответах в Chrome DevTools. Поддерживает протокол HTTP и STDIO.
КэшированиеGuidancePlugin	Отображает предупреждение, когда прокси-сервер разработки перехватил тот же запрос в течение указанного периода времени.
CrudApiPlugin	Имитирует API CRUD с хранилищем данных в памяти.
ExecutionSummaryPlugin	Создает сводный отчет о запросах, проходящих через прокси-сервер.
GenericRandomErrorPlugin	Отклоняет запросы со случайной выбранной ошибкой из файла, содержащего смоделированные ошибки.
HarGeneratorPlugin	Создает файлы HTTP-архива (HAR) из перехватанных запросов и ответов.
HttpFileGeneratorPlugin	Создает HTTP-файл из перехватанных запросов и ответов.
LanguageModelFailurePlugin	Имитирует различные сценарии сбоя языковой модели для тестирования устойчивости приложений, зависимых от языковой модели.
LanguageModelRateLimitingPlugin	Имитирует ограничение скорости на основе токенов для API языковой модели путем отслеживания запроса и потребления токенов завершения в настраиваемых временных окнах.
Плагин задержки	Задержка ответов случайным числом миллисекунд из настроенного диапазона. Поддерживает протокол HTTP и STDIO.
MinCsomPermissionsPlugin	Обнаруживает минимальные разрешения, необходимые для вызова записанных запросов API SharePoint Client-Side объектной модели (CSOM).
МинимальныеРазрешенияПлагин	Возвращает минимальные разрешения, необходимые для вызова записанных запросов API. Использует сведения API из указанной локальной папки.
MinPermissionsGuidancePlugin	Сравнивает разрешения, используемые в маркере JWT, отправляемые API, с минимальными необходимыми областями, необходимыми для запросов, записанных прокси-сервером, и показывает разницу.
MockGeneratorPlugin	Создает макеты прокси-сервера разработки на основе перехватанных запросов.
MockRequestPlugin	Позволяет выдавать веб-запросы с помощью Dev Proxy.
MockResponsePlugin	Имитирует ответы.
MockStdioResponsePlugin	Имитирует ответы для приложений на основе STDIO, таких как серверы MCP.
ODataPagingGuidancePlugin	Отображает предупреждение, когда прокси-сервер перехватывает запрос на разбиение по страницам OData с URL-адресом, который не использовался ранее в одном из перехваченных ответов.
OpenAIMockResponsePlugin	Имитирует ответы из Azure OpenAI и OpenAI с помощью локальной языковой модели.
OpenAITelemetryPlugin	Создает данные телеметрии для запросов API, совместимых с OpenAI.
OpenAIUsageDebuggingPlugin	Регистрирует метрики использования API OpenAI в CSV-файл для отладки и анализа.
OpenApiSpecGeneratorPlugin	Создает спецификацию OpenAPI из перехватанных запросов и ответов.
RateLimitingPlugin	Имитирует поведение ограничения скорости.
RetryAfterPlugin	Имитирует Retry-After заголовок, отправленный API после ограничения запроса.
Переопределение плагина	Перезаписывает запросы.
TypeSpecGeneratorPlugin	Создает файлы TypeSpec из перехватанных запросов и ответов.
UrlDiscoveryPlugin	Создает список URL-адресов, перехватываемых прокси-сервером.

Плагины Центра API Azure

Список плагинов, работающих с Центром API Azure.

Имя	Описание
ApiCenterMinimalPermissionsPlugin	Проверяет, использует ли приложение минимальные разрешения для вызова API. Использует сведения API из указанного экземпляра Центра API Azure.
ApiCenterOnboardingPlugin	Проверяет, зарегистрированы ли API, используемые в приложении, в указанном экземпляре Центра API Azure.
ApiCenterProductionVersionPlugin	Проверяет, являются ли API-интерфейсы, используемые в приложении, рабочей версией API, зарегистрированными в указанном экземпляре Центра API Azure.

Плагины Microsoft Entra

Список плагинов, работающих с API Microsoft Entra.

Имя	Описание
EntraMockResponsePlugin	Имитирует ответы на Microsoft Entra.

Плагины Microsoft Graph

Список плагинов, работающих с API Microsoft Graph.

Имя	Описание
GraphBetaSupportGuidancePlugin	Отображает предупреждение, когда прокси обнаруживает запрос к конечной точке бета-версии Microsoft Graph.
GraphClientRequestIdGuidancePlugin	Показывает подсказку, если запрос к API Microsoft Graph не включает заголовок client-request-id.
GraphConnectorGuidancePlugin	Показывает контекстное руководство по работе с соединителями Microsoft Graph.
GraphMinimalPermissionsPlugin	Возвращает список минимальных разрешений, необходимых для запросов Microsoft Graph, записанных прокси-сервером.
GraphMinimalPermissionsGuidancePlugin	Сравнивает разрешения, используемые в токене JWT, отправляемом в Microsoft Graph, с минимальными необходимыми областями действий для запросов, которые проксируются, и показывает разницу.
GraphMockResponsePlugin	Симулирует ответы на Microsoft Graph API.
GraphRandomErrorPlugin	Запросы к Microsoft Graph завершаются сбоем со случайными ошибками.
GraphSdkGuidancePlugin	Показывает подсказку, когда прокси-сервер перехватывает запрос к Microsoft Graph, который не был создан с помощью SDK Microsoft Graph.
GraphSelectGuidancePlugin	Отображает предупреждение, когда прокси-сервер перехватывает запрос к API Microsoft Graph, который не включает параметр $select в строке запроса.
ODSPSearchGuidancePlugin	Отображает предупреждение, когда прокси-сервер разработки обнаруживает запрос к API поиска OneDrive и SharePoint.

Журналистам

Список репортеров, создающих отчеты в различных форматах.

Имя	Описание
JsonReporter	Создает отчеты в формате JSON.
MarkdownReporter	Создает отчеты в формате Markdown.
PlainTextReporter	Создает отчеты в формате обычного текста.

Настройка

Справочник по параметрам конфигурации прокси-сервера для разработки.

Имя	Описание
devproxyrc	Файл конфигурации для прокси-сервера разработки.
API прокси-сервера	API для взаимодействия через код с Dev Proxy.
Параметры прокси-сервера	Параметры конфигурации для параметров прокси-сервера.