Partilhar via

Configurar Proxy de Desenvolvimento

  • Artigo

O Dev Proxy é altamente configurável. Ela utiliza pluggins para implementar funcionalidades. Você pode combinar qualquer um dos plugins padrão, e para construir o seu próprio. Usando plugins e configurações personalizadas, você pode adaptar o Dev Proxy às suas necessidades específicas. O Dev Proxy inclui um arquivo de configuração padrão, chamado devproxyrc.json. O arquivo está localizado na pasta de instalação do Dev Proxy.

Dica

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

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

Estrutura do arquivo de configuração

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

{
  "$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 seu arquivo de configuração seja válido, certifique-se de usar a mesma versão do esquema que a versão do Proxy de Desenvolvimento que você está usando.
  • A lista de plug-ins que o Dev Proxy usa, definida na matriz plugins.
  • Definições gerais de configuração .

Importante

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

Alguns plugins 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 de 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 plugin, cada uma com uma configuração diferente. Você pode precisar fazer referência ao mesmo plug-in várias vezes, por exemplo, ao simular várias APIs com respostas de erro e comportamentos diferentes.

Kit de ferramentas de proxy de desenvolvimento

Dev Proxy Toolkit é uma extensão do Visual Studio Code que simplifica significativamente a configuração do Dev Proxy. Aqui estão algumas das características que inclui:

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

Dica

Se você usa o Visual Studio Code, é altamente recomendável que você instalar a extensão do Dev Proxy Toolkit.

Próximo passo

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

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