Configurar o Dev Proxy

O Dev Proxy é uma ferramenta de linha de comando que ajuda a simular comportamentos e erros de APIs na nuvem para ajudá-lo a criar aplicativos resilientes.

Neste tutorial, você aprenderá a instalar e executar o Dev Proxy.

Instalar o Dev Proxy

A maneira mais fácil de instalar o Dev Proxy é usando winget. Como alternativa, você pode instalar o Dev Proxy manualmente.

Para instalar o Dev Proxy usando winget, execute o seguinte comando:

winget install Microsoft.DevProxy --silent

Importante

O instalador do Dev Proxy adiciona uma nova entrada ao PATH. Para usar o Dev Proxy após a instalação, reinicie o prompt de comando para atualizar a variável de ambiente PATH.

Manual

Download a versão mais recente e extraia os arquivos para uma pasta. Para este tutorial, assumimos que você extrai os arquivos em uma pasta chamada devproxy localizada em seu diretório inicial.

Para iniciar o Dev Proxy a partir de qualquer diretório, adicione o local da pasta de instalação ao seu PATH.

1. Abra o menu Start.
2. Introduza Edit environment variables for your account na caixa de pesquisa. Selecione o resultado na lista para abrir a caixa de diálogo Environment Variables.
3. Na seção User variables for <username>, selecione a linha com o nome da variável Path e selecione o botão Edit....
4. Na caixa de diálogo Edit environment variable, selecione o botão New.
5. Introduza %USERPROFILE%\devproxy na nova linha e selecione OK.
6. Para confirmar as alterações, selecione OK.

Observação

Para experimentar os recursos de visualização mais recentes, instale a versão beta do Dev Proxy.

Para instalar o Dev Proxy usando winget, execute o seguinte comando:

winget install Microsoft.DevProxy.Beta --silent

Manual

Download a versão beta mais recente e extraia os arquivos para uma pasta. Siga as etapas de configuração manual conforme descrito anteriormente.

Para executar a versão beta do Dev Proxy, use devproxy-beta

A maneira mais fácil de instalar o Dev Proxy é usando o Homebrew. Como alternativa, você pode instalar o Dev Proxy manualmente.

Para instalar o Dev Proxy usando o Homebrew, execute os seguintes comandos:

brew tap dotnet/dev-proxy
brew install dev-proxy

Manual

Download a versão mais recente e extraia os arquivos para uma pasta. Para este tutorial, assumimos que você extrai os arquivos em uma pasta chamada devproxy localizada em seu diretório inicial.

Para iniciar o Dev Proxy a partir de qualquer diretório, adicione o local da pasta de instalação ao seu PATH.

As etapas abaixo mostram como adicionar o proxy ao PATH ao usar zsh shell. Dependendo do shell que você usa, seu arquivo de perfil pode ser diferente.

1. Abra seu perfil de shell em um editor de texto >~/.zshrc.
2. Atualize a variável de ambiente PATH com a localização do proxy >export PATH=".:$PATH:$HOME/devproxy".
3. Recarregue seu perfil >source ~/.zshrc.

Observação

Para experimentar os recursos de visualização mais recentes, instale a versão beta do Dev Proxy.

Para instalar o Dev Proxy usando o Homebrew, execute os seguintes comandos:

brew tap dotnet/dev-proxy
brew install dev-proxy-beta

Manual

Download a versão beta mais recente e extraia os arquivos para uma pasta. Siga as etapas de configuração manual conforme descrito anteriormente.

Para executar a versão beta do Dev Proxy, use devproxy-beta

A maneira mais fácil de instalar o Dev Proxy é usando o script de instalação. Como alternativa, você pode instalar o Dev Proxy manualmente.

Para instalar o Dev Proxy usando o script de instalação, execute os seguintes comandos:

bash -c "$(curl -sL https://aka.ms/devproxy/setup.sh)"

Se você usar o PowerShell, execute o seguinte comando:

(Invoke-WebRequest https://aka.ms/devproxy/setup.ps1).Content | Invoke-Expression

Manual

Download a versão mais recente e extraia os arquivos para uma pasta. Para este tutorial, assumimos que você extrai os arquivos em uma pasta chamada devproxy localizada em seu diretório inicial.

Para iniciar o Dev Proxy a partir de qualquer diretório, adicione o local da pasta de instalação ao seu PATH.

As etapas abaixo mostram como adicionar o proxy ao PATH ao usar o shell bash. Dependendo do shell que você usa, seu arquivo de perfil pode ser diferente.

1. Abra seu perfil de shell em um editor de texto >~/.bashrc.
2. Atualize a variável de ambiente PATH com a localização do proxy >export PATH=".:$PATH:$HOME/devproxy".
3. Recarregue seu perfil >source ~/.bashrc.

Observação

Para experimentar os recursos de visualização mais recentes, instale a versão beta do Dev Proxy.

Automático

Para instalar o Dev Proxy usando o script de instalação, execute os seguintes comandos:

bash -c "$(curl -sL https://aka.ms/devproxy/setup-beta.sh)"

Se você usar o PowerShell, execute o seguinte comando:

(Invoke-WebRequest https://aka.ms/devproxy/setup-beta.ps1).Content | Invoke-Expression

Manual

Download a versão beta mais recente e extraia os arquivos para uma pasta. Siga as etapas de configuração manual conforme descrito anteriormente.

Para executar a versão beta do Dev Proxy, use devproxy-beta

Iniciar o Dev Proxy pela primeira vez

Na primeira vez que você iniciar o Dev Proxy em sua máquina, há algumas etapas a serem seguidas para garantir que o Dev Proxy possa intercetar solicitações de sua máquina e responder com êxito. Você não precisará repetir essas etapas após a primeira execução.

1. Inicie o Dev Proxy. Abra uma sessão de linha de comando. Digite devproxy e pressione Enter.
2. Certificado de confiança. O Dev Proxy instala um certificado chamado Dev Proxy CA. Aparece um aviso. Selecione Yes para confirmar que deseja instalar o certificado. O Dev Proxy usa esse certificado para descriptografar o tráfego HTTPS enviado da sua máquina.
3. Permitir acesso ao firewall. O Firewall do Windows bloqueia o proxy. Aparece um aviso. Selecione Allow access botão para permitir o tráfego através do firewall.

1. Inicie o Dev Proxy. Abra uma sessão de prompt de comando. Digite devproxy e pressione . Insira.
2. Certificado de confiança. O Dev Proxy instala um certificado chamado Dev Proxy CA, que ele usa para descriptografar o tráfego HTTPS enviado da sua máquina. Aparece um aviso. Pressione y para confirmar que deseja confiar no certificado.
3. Aceitar conexões de entrada. Aparece um aviso. Selecione Allow para confirmar.

1. Inicie o Dev Proxy. Abra uma sessão de prompt de comando. Digite devproxy e pressione . Introduza.

2. Certificado de confiança. O Dev Proxy usa um certificado SSL personalizado para descriptografar o tráfego HTTPS enviado da sua máquina.

   Importante

   As instruções a seguir são para o Ubuntu. Para outras distribuições Linux, as etapas podem ser diferentes.

   Para instalar e confiar no certificado, em um novo prompt de comando, execute os seguintes comandos:

   # Export Dev Proxy root certificate
   openssl pkcs12 -in ~/.config/dev-proxy/rootCert.pfx -clcerts -nokeys -out dev-proxy-ca.crt -passin pass:""
   # Install the certificate
   sudo cp dev-proxy-ca.crt /usr/local/share/ca-certificates/
   # Update certificates
   sudo update-ca-certificates
   

O prompt de comando exibe a seguinte saída:

 info    8 error responses loaded from devproxy-errors.json
 info    Dev Proxy API listening on http://localhost:8897...
 info    Dev Proxy Listening on 127.0.0.1:8000...

Hotkeys: issue (w)eb request, (r)ecord, (s)top recording, (c)lear screen
Press CTRL+C to stop Dev Proxy

Por padrão, o Proxy de Desenvolvimento é configurado para:

• Intercetar solicitações feitas a qualquer endpoint da API JSON Placeholder
• Simule respostas de erro de API e restrição de API com uma taxa de falha de 50%

Confirme se o Dev Proxy está funcionando corretamente

O Dev Proxy interceta solicitações que os aplicativos em sua máquina fazem para URLs que você registra com o Dev Proxy. Quando o Proxy de Desenvolvimento deteta uma solicitação, ele a passa para a API (não executa nenhuma ação) ou retorna uma resposta. Vamos confirmar se o Dev Proxy está funcionando conforme o esperado.

No PowerShell, use o cmdlet Invoke-WebRequest para enviar uma solicitação GET para a API de espaço reservado JSON.

Invoke-WebRequest -Uri https://jsonplaceholder.typicode.com/posts

Se você usar curl, envie uma solicitação GET para a API de espaço reservado JSON usando o comando a seguir.

curl -ikx http://localhost:8000 https://jsonplaceholder.typicode.com/posts

Você também pode usar um cliente de API como Postman para enviar uma solicitação GET para https://jsonplaceholder.typicode.com/posts.

Na linha de comando onde o Proxy de Desenvolvimento está sendo executado, você verá as informações sobre a solicitação e a ação que o Proxy de Desenvolvimento executou. Por padrão, o Dev Proxy simula uma resposta de erro com uma chance de 50%. Se sua solicitação não retornar um erro, o Dev Proxy o passará.

 req   ╭ GET https://jsonplaceholder.typicode.com/posts
 time  │ 1/31/2025 12:12:14 PM +00:00
 skip  │ RetryAfterPlugin: Request not throttled
 skip  │ GenericRandomErrorPlugin: Pass through
 api   ╰ Passed through

Se o Dev Proxy retornar uma resposta de erro, você verá a mensagem de erro na saída.

 req   ╭ GET https://jsonplaceholder.typicode.com/posts
 time  │ 1/31/2025 12:12:37 PM +00:00
 skip  │ RetryAfterPlugin: Request not throttled
 oops  ╰ 403 Forbidden

Importante

Se não vires nenhuma saída na linha de comandos, é provável que o Dev Proxy não esteja a intercetar pedidos. Consulte a secção problemas comuns para obter ajuda.

Pare o Dev Proxy com segurança

Quando você não precisar mais que o Dev Proxy esteja em execução, você deve sempre pará-lo com segurança.

• Pressione Ctrl + C para parar o Dev Proxy com segurança.

Se encerrar a sessão do prompt de comando, o Dev Proxy não se desregistra corretamente como o proxy do sistema, e poderá experimentar alguns problemas comuns.

Próximo passo

Saiba como configurar o Dev Proxy de acordo com suas necessidades. O Dev Proxy é altamente flexível e suporta muitos cenários diferentes. Saiba mais sobre como configurá-lo para o seu cenário específico.

Configurar o Dev Proxy