Compartilhar via

Configurar o Proxy de Desenvolvimento

  • Artigo

O Proxy de Desenvolvimento é altamente configurável. Ele usa plug-ins para implementar a funcionalidade. Você pode combinar qualquer um dos plug-ins padrão e criar seu próprio. Usando plug-ins e configurações personalizadas, você pode adaptar o Proxy de Desenvolvimento às suas necessidades específicas. O Proxy de Desenvolvimento inclui um arquivo de configuração padrão, chamado devproxyrc.json. O arquivo está localizado na pasta de instalação do Proxy de Desenvolvimento.

Dica

Recomendamos que você crie arquivos de configuração personalizados. Usando arquivos de configuração personalizados, você pode alternar facilmente entre configurações diferentes e incluí-las no sistema de controle do código-fonte junto com o código do projeto. Armazenar sua configuração com seu projeto também facilita o compartilhamento com sua equipe.

Se você nomear seu arquivo de configuração devproxyrc.json ou devproxyrc.jsonc, o Proxy de Desenvolvimento o carregará automaticamente do diretório atual ao iniciá-lo. Para outros nomes, especifique o caminho do arquivo no argumento --config-file ao iniciar o Proxy de Desenvolvimento, por exemplo, devproxy --config-file ./my-devproxy-config.json.

Estrutura de arquivo de configuração

O snippet de código a seguir mostra o arquivo de configuração padrão do Proxy de Desenvolvimento:

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.24.0/rc.schema.json",
  "plugins": [
    {
      "name": "RetryAfterPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll"
    },
    {
      "name": "GenericRandomErrorPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
      "configSection": "genericRandomErrorPlugin"
    }
  ],
  "urlsToWatch": [
    "https://jsonplaceholder.typicode.com/*"
  ],
  "genericRandomErrorPlugin": {
    "errorsFile": "devproxy-errors.json"
  },
  "rate": 50,
  "logLevel": "information",
  "newVersionNotification": "stable",
  "showSkipMessages": true,
  "showTimestamps": true
}

O arquivo de configuração consiste em três seções:

  • Esquema, definido na propriedade $schema. Para garantir que o arquivo de configuração seja válido, use a mesma versão de esquema que a versão do Proxy de Desenvolvimento que você está usando.
  • A lista de plug-ins que o Proxy de Desenvolvimento usa, definida na matriz plugins.
  • Configurações gerais.

Importante

O Dev Proxy aplica plugins na ordem em que estão listados no arquivo de configuração. Esteja atento à ordem para obter o comportamento desejado.

Alguns plug-ins são configuráveis e expõem suas próprias configurações. Cada plug-in tem sua própria seção de configuração no arquivo de configuração, referenciada pela propriedade configSection na definição do plug-in. Consulte a documentação de referência para cada plug-in para saber mais sobre suas opções de configuração.

Dica

O valor da propriedade configSection pode ser qualquer cadeia de caracteres. Usando nomes diferentes, você pode incluir várias instâncias do mesmo plug-in, cada uma com uma configuração diferente. Talvez seja necessário referenciar o mesmo plug-in várias vezes, por exemplo, ao zombar de várias APIs com diferentes respostas e comportamentos de erro.

Kit de ferramentas de proxy para desenvolvimento

Dev Proxy Toolkit é uma extensão do Visual Studio Code que simplifica significativamente a configuração do Dev Proxy. Aqui estão alguns dos recursos que ele inclui:

  • trechos de código para cenários comuns de configuração
  • lint estendido e IntelliSense para arquivos de configuração do Proxy de Desenvolvimento
  • ações e comandos personalizados do editor para iniciar e parar convenientemente o Proxy de Desenvolvimento
  • notificações sobre novas versões do Proxy de Desenvolvimento

Dica

Se você usar o Visual Studio Code, é altamente recomendável instalar a extensão do Kit de Ferramentas de Proxy de Desenvolvimento.

Próxima etapa

Se você quiser continuar aprendendo sobre como usar o Proxy de Desenvolvimento, considere os seguintes tutoriais:

Caso contrário, confira nossos guias de instruções para aprender a usar o Proxy de Desenvolvimento para cenários específicos.