Simule erros aleatórios para a sua própria aplicação

Neste tutorial, você aprenderá a usar o Dev Proxy para simular erros aleatórios para seu próprio aplicativo.

Pré-requisitos

Esta parte do tutorial pressupõe que você instalou e configurou o Dev Proxy em sua máquina. Se não, faça isso agora.

Para seguir este tutorial, você precisa de um aplicativo que chame APIs. Você também precisa saber as URLs das APIs que seu aplicativo chama.

Você pode usar o Dev Proxy com qualquer tipo de aplicação e conjunto tecnológico. Aqui estão instruções sobre como configurar o Dev Proxy com algumas tecnologias populares.

JavaScript

Utilize o Dev Proxy com o seguinte:

• Node.js aplicações
• Node.js aplicações no Docker
• JavaScript Azure Functions
• soluções da Estrutura do SharePoint (SPFx)

.NET

Utilize o Dev Proxy com:

• aplicações .NET
• aplicações .NET em Docker
• aplicações .NET Aspire

Se você estiver usando o Dev Proxy com um aplicativo .NET 4.8, precisará registrar o Dev Proxy em seu sistema usando netsh.

Outros

Se você quiser usar o Dev Proxy com um aplicativo do lado do cliente, normalmente não precisará executar nenhuma etapa extra. Depois de iniciar o Dev Proxy, ele interceta automaticamente todas as solicitações da sua máquina.

Se você quiser usar o Proxy de Desenvolvimento com um aplicativo do lado do servidor criado com uma tecnologia não listada aqui, talvez seja necessário executar etapas adicionais para configurar seu aplicativo para usar o Proxy de Desenvolvimento. Consulte a documentação da sua tecnologia para saber como configurá-la para usar um proxy de rede. Se você tiver alguma dúvida, peça ajuda no da comunidade Dev Proxy no Discord.

Inicie o Dev Proxy monitorando suas URLs

Inicie o Dev Proxy e monitore as URLs das APIs que seu aplicativo chama. Por exemplo, se seu aplicativo chamar uma API localizada em https://api.contoso.com/v1/customers, inicie o Dev Proxy e monitore o padrão de URL https://api.contoso.com/*.

devproxy --urls-to-watch "https://api.contoso.com/*"

O parâmetro --urls-to-watch informa ao Dev Proxy quais pedidos deve intercetar. O * curinga no final da URL informa ao Dev Proxy para intercetar todas as solicitações para URLs que comecem com https://api.contoso.com/.

Comece a usar seu aplicativo como faria normalmente. O Dev Proxy interceta todas as solicitações para as URLs que especificou. No prompt de comando, é possível ver mensagens sobre as solicitações que o Dev Proxy interceta.

```text
 request     GET https://api.contoso.com/v1/customers
     api   ╭ Passed through
           ╰ GET https://api.contoso.com/v1/customers
 request     GET https://api.contoso.com/v1/customers
   chaos   ╭ 403 Forbidden
           ╰ GET https://api.contoso.com/v1/customers

Importante

Se você não vir nenhuma mensagem no prompt de comando, certifique-se de que configurou corretamente seu aplicativo para usar o Proxy de Desenvolvimento. Além disso, verifique se o Dev Proxy está intercetando solicitações para URLs de API que seu aplicativo usa. Se você tiver alguma dúvida, peça ajuda no da comunidade Dev Proxy no Discord.

Crie seus próprios arquivos de configuração

Por padrão, o Dev Proxy usa o arquivo devproxyrc.json na pasta de instalação do Dev Proxy para suas definições de configuração. O ficheiro está configurado para simular erros aleatórios na API JSON Placeholder. Para obter resultados mais realistas, crie seus próprios arquivos de configuração com erros que são mais relevantes para seu aplicativo e as APIs que ele usa e use-os com o Dev Proxy.

Vamos considerar que você deseja armazenar um arquivo de configuração na pasta do projeto para seu aplicativo, para que possa compartilhar as definições de configuração com o resto da sua equipe.

1. Na pasta de instalação do Dev Proxy, copie devproxyrc.json e devproxy-errors.json.
2. Na pasta do projeto, cole os arquivos.

Ao usar um arquivo de configuração armazenado fora do arquivo de instalação do Proxy de Desenvolvimento, você precisa garantir que as referências de pluginPath estejam corretas. Em vez de codificar os caminhos para a pasta de instalação do Proxy de Desenvolvimento no arquivo de configuração, você pode usar o ~appFolder no início do caminho para incluir uma referência dinâmica de volta à pasta de instalação do Proxy de Desenvolvimento.

1. Em um editor de texto, abra o arquivo devproxyrc.json.
2. Localize o plug-in GenericRandomErrorPlugin na matriz plugins.
3. Atualize o pluginPath para ~appFolder/plugins/dev-proxy-plugins.dll.
4. Localize o plug-in RetryAfterPlugin na matriz plugins.
5. Atualize o pluginPath para ~appFolder/plugins/dev-proxy-plugins.dll.
6. Em um prompt de comando, altere o diretório de trabalho para a pasta do projeto.
7. Digite devproxy --config-file devproxyrc.json e pressione Enter para iniciar o Dev Proxy usando seu arquivo de configuração.
8. Envie uma solicitação para a API de espaço reservado JSON a partir da linha de comando e visualize a saída.
9. Pressione Ctrl + C para parar o Dev Proxy com segurança.

Dica

Instale a extensão do Dev Proxy Toolkit para Visual Studio Code, que facilita a criação e atualização de arquivos de configuração.

Próximo passo

O Dev Proxy suporta muitos cenários diferentes que ajudam a criar aplicativos mais robustos. Explore os guias de instruções para saber como usar os diferentes recursos do Dev Proxy e melhorar seu aplicativo.

Explore guias de instruções