Referência técnica para Dev Proxy

Esta seção contém referência técnica para plug-ins do Dev Proxy e opções de configuração.

Qual plug-in devo usar para relatórios e análises?

Use a tabela a seguir para escolher o plug-in que corresponde ao que você deseja aprender sobre o tráfego de API do aplicativo. Os plug-ins que produzem um relatório precisam de um reporter, como JsonReporter, MarkdownReporter ou PlainTextReporter, para salvar o relatório em um arquivo. Os plug-ins do gerador gravam seu arquivo de saída diretamente. O Dev Proxy cria os arquivos de saída no diretório de trabalho atual depois que você interrompe a gravação.

Goal	plugin + reporter	Arquivo de saída
Inventariar as URLs que meu aplicativo acessa	UrlDiscoveryPlugin + JsonReporter	UrlDiscoveryPlugin_JsonReporter.json
Contar solicitações e seus desfechos	ExecutionSummaryPlugin + MarkdownReporter ou JsonReporter	ExecutionSummaryPlugin_MarkdownReporter.md ou ExecutionSummaryPlugin_JsonReporter.json
Captura completa de solicitações e respostas	HarGeneratorPlugin	devproxy-yyyyMMddHHmmss.har
Criar requisições reproduzíveis	HttpFileGeneratorPlugin	requests_yyyyMMddHHmmss.http
Criar uma especificação de API a partir do tráfego	OpenApiSpecGeneratorPlugin ou TypeSpecGeneratorPlugin	host-port-yyyyMMddHHmmss.json (ou .yaml) por host de API ou name-yyyyMMddHHmmss.tsp por host de API
Criar mocks a partir do tráfego	MockGeneratorPlugin	mocks-yyyyMMddHHmmss.json
Localizar as permissões mínimas que meu aplicativo precisa	MinimalPermissionsPlugin + MarkdownReporter ou JsonReporter	MinimalPermissionsPlugin_MarkdownReporter.md ou MinimalPermissionsPlugin_JsonReporter.json

Note

Se já existir um arquivo de relatório com o mesmo nome, o repórter acrescentará um carimbo de data/hora ao nome do arquivo, por exemplo UrlDiscoveryPlugin_JsonReporter_yyyyMMddHHmmss.json. Para Microsoft Graph APIs, use GraphMinimalPermissionsPlugin para encontrar as permissões mínimas.

Plug-ins

Lista de plugins que funcionam com qualquer API.

Nome	Descrição
AuthPlugin	Simula autenticação e autorização usando chaves de API ou OAuth2.
DevToolsPlugin	Expõe mensagens do Dev Proxy e informações sobre solicitações e respostas interceptadas no Chrome DevTools. Dá suporte a HTTP e STDIO.
CachingGuidancePlugin	Mostra um aviso quando o Dev Proxy interceptou a mesma solicitação dentro do período de tempo especificado.
CrudApiPlugin	Simula uma API CRUD com um armazenamento de dados na memória.
ExecutionSummaryPlugin	Gera um relatório resumido das solicitações que passam pelo proxy.
GenericRandomErrorPlugin	Rejeita solicitações com um erro selecionado aleatoriamente de um arquivo que contém erros simulados.
HarGeneratorPlugin	Gera arquivos HTTP Archive (HAR) das solicitações e respostas interceptadas.
HttpFileGeneratorPlugin	Gera arquivo HTTP a partir das solicitações e respostas interceptadas.
LanguageModelFailurePlugin	Simula vários cenários de falha do modelo de linguagem para testar a resiliência de aplicativos dependentes do modelo de linguagem.
LanguageModelRateLimitingPlugin	Simula a limitação de taxa com base em tokens para APIs de modelos de linguagem, monitorando o consumo de tokens de prompt e de conclusão em janelas de tempo configuráveis.
LatencyPlugin	Atrasa as respostas em um número aleatório de milissegundos do intervalo configurado. Dá suporte a HTTP e STDIO.
MinimalCsomPermissionsPlugin	Detecta as permissões mínimas necessárias para chamar as solicitações de API do CSOM (Modelo de Objeto Client-Side) do SharePoint registradas.
MinimalPermissionsPlugin	Retorna as permissões mínimas necessárias para chamar as solicitações de API registradas. Usa informações de API da pasta local especificada.
MinimalPermissionsGuidancePlugin	Compara as permissões usadas no token JWT enviadas para APIs com os escopos mínimos necessários para solicitações que o proxy registrou e mostra a diferença.
MockGeneratorPlugin	Gera simulações do Dev Proxy com base nas solicitações interceptadas.
MockRequestPlugin	Permite que você emita solicitações da Web usando o Dev Proxy.
MockResponsePlugin	Simula respostas.
MockStdioResponsePlugin	Simula respostas para aplicativos baseados em STDIO, como servidores MCP.
ODataPagingGuidancePlugin	Mostra um aviso quando o proxy intercepta uma solicitação de paginação OData usando uma URL que não foi retornada anteriormente em uma das respostas interceptadas.
OpenAIMockResponsePlugin	Simula respostas do Azure OpenAI e OpenAI usando um modelo de idioma local.
OpenAITelemetryPlugin	Gera dados de telemetria para solicitações de API compatíveis com OpenAI.
OpenAIUsageDebuggingPlugin	Registra métricas de uso da API OpenAI em um arquivo CSV para fins de depuração e análise.
OpenApiSpecGeneratorPlugin	Gera a especificação OpenAPI das solicitações e respostas interceptadas.
RateLimitingPlugin	Simula comportamentos de limitação de taxa.
RetryAfterPlugin	Simula o cabeçalho Retry-After enviado por uma API após a limitação de uma solicitação.
RewritePlugin	Reescreve as solicitações.
TypeSpecGeneratorPlugin	Gera arquivos TypeSpec das solicitações e respostas interceptadas.
UrlDiscoveryPlugin	Cria uma lista de URLs interceptadas pelo proxy.

Plug-ins do Centro de API do Azure

Lista de plug-ins que funcionam com o Centro de API do Azure.

Nome	Descrição
ApiCenterMinimalPermissionsPlugin	Verifica se o aplicativo usa permissões mínimas para chamar APIs. Usa informações de API da instância especificada do Centro de API do Azure.
ApiCenterOnboardingPlugin	Verifica se as APIs usadas em um aplicativo estão registradas na instância especificada do Centro de API do Azure.
ApiCenterProductionVersionPlugin	Verifica se as APIs usadas em um aplicativo são a versão de produção das APIs registradas na instância especificada do Centro de API do Azure.

Plug-ins do Microsoft Entra

Lista de plug-ins que funcionam com a API do Microsoft Entra.

Nome	Descrição
EntraMockResponsePlugin	Simula respostas para o Microsoft Entra.

Plug-ins do Microsoft Graph

Lista de plug-ins que funcionam com a API do Microsoft Graph.

Nome	Descrição
GraphBetaSupportGuidancePlugin	Mostra um aviso quando o proxy detecta uma solicitação para o endpoint beta do Microsoft Graph.
GraphClientRequestIdGuidancePlugin	Mostra uma dica quando uma solicitação para a API do Microsoft Graph não inclui o client-request-id cabeçalho.
GraphConnectorGuidancePlugin	Mostra diretrizes contextuais para trabalhar com conectores do Microsoft Graph.
GraphMinimalPermissionsPlugin	Retorna uma lista das permissões mínimas necessárias para solicitações do Microsoft Graph que o proxy registrou.
GraphMinimalPermissionsGuidancePlugin	Compara as permissões usadas no token JWT enviado ao Microsoft Graph com os escopos mínimos necessários para solicitações que o proxy registrou e mostra a diferença.
Plug-in de resposta do GraphMock	Simula respostas às APIs do Microsoft Graph.
GraphRandomErrorPlugin	Falha as solicitações feitas ao Microsoft Graph com erros aleatórios.
GraphSdkGuidancePlugin	Mostra uma dica quando o proxy intercepta uma solicitação para o Microsoft Graph que não foi emitida por um SDK do Microsoft Graph.
GraphSelectGuidancePlugin	Mostra um aviso quando o proxy intercepta uma solicitação para as APIs do Microsoft Graph que não inclui o parâmetro de string de consulta $select.
ODSPSearchGuidancePlugin	Mostra um aviso quando o Proxy de Desenvolvimento detecta uma solicitação para APIs de pesquisa do OneDrive e do SharePoint.

Repórteres

Lista de repórteres que geram relatórios em diferentes formatos.

Nome	Descrição
JsonReporter	Gera relatórios no formato JSON.
Repórter de Markdown	Gera relatórios no formato Markdown.
Repórter de texto simples	Gera relatórios em formato de texto simples.

Configuração

Referência das opções de configuração do Dev Proxy.

Nome	Descrição
devproxyrc	Arquivo de configuração para Dev Proxy.
Proxy API	API para interagir com o Dev Proxy programaticamente.
Configurações de proxy	Opções de configuração para configurações de proxy.