UrlDiscoveryPlugin

Cria uma lista de URLs interceptadas pelo Proxy de Desenvolvimento. Use esse plug-in para saber quais URLs seu aplicativo está chamando e como configurar o Proxy de Desenvolvimento para simular comportamentos para eles.

Ponta

Para salvar o resumo em um arquivo, use um plug-in de repórter em sua configuração.

Exemplo de configuração

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "UrlDiscoveryPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll"
    }
  ]
}

Propriedades de configuração

Nenhum

Output

UrlDiscoveryPlugin cria seu relatório quando você para de gravar. O relatório contém as URLs exclusivas das solicitações interceptadas pelo Proxy de Desenvolvimento, classificadas em ordem alfabética. Cada URL é a URL de solicitação completa, incluindo sua cadeia de caracteres de consulta.

Para salvar o relatório como JSON, adicione o JsonReporter após UrlDiscoveryPlugin em sua configuração. JsonReporter grava o relatório em um arquivo nomeado UrlDiscoveryPlugin_JsonReporter.jsonc no diretório de trabalho atual. Se o arquivo já existir, o Proxy de Desenvolvimento acrescentará um carimbo de data/hora ao nome do arquivo, por exemplo UrlDiscoveryPlugin_JsonReporter_20261105104151.jsonc.

O arquivo é um JSON com jsonc (comentários) que você pode usar como ponto de partida para a urlsToWatch propriedade em sua configuração de Proxy de Desenvolvimento. O arquivo contém comentários que explicam como usar curingas e excluir URLs, seguidos por uma urlsToWatch matriz com as URLs interceptadas:

{
  // Wildcards
  // 
  // You can use wildcards to catch multiple URLs with the same pattern.
  // For example, you can use the following URL pattern to catch all API requests to
  // JSON Placeholder API:
  // 
  // https://jsonplaceholder.typicode.com/*
  // 
  // Excluding URLs
  // 
  // You can exclude URLs with ! to prevent them from being intercepted.
  // For example, you can exclude the URL https://jsonplaceholder.typicode.com/authors
  // by using the following URL pattern:
  // 
  // !https://jsonplaceholder.typicode.com/authors
  // https://jsonplaceholder.typicode.com/*
  "urlsToWatch": [
    "https://jsonplaceholder.typicode.com/posts",
    "https://jsonplaceholder.typicode.com/users",
    "https://jsonplaceholder.typicode.com/users/1"
  ]
}

Propriedade	Description
urlsToWatch	Array de strings. As URLs exclusivas das solicitações interceptadas pelo Proxy de Desenvolvimento durante a gravação foram classificadas em ordem alfabética. As URLs não contêm curingas

Important

Como o arquivo contém comentários, os analisadores JSON padrão, como JSON.parse em JavaScript ou jq, não conseguem analisá-lo. Para ler o arquivo em um script, use um analisador que dê suporte a comentários, como JSON5 ou o jsonc-parser pacote npm, ou remova as linhas de comentário antes de analisar o arquivo.

Consulte também

• Registro de scripts e CI
• Use o Dev Proxy em cenários de CI/CD
• Proxy API

Próxima etapa

Descobrir URLs para observar