Usar o Dev Proxy com aplicativos .NET Aspire

.NET Aspire é uma stack estruturada e preparada para a nuvem para criar aplicações observáveis, prontas para uso em produção e distribuídas. Ele foi criado com base no .NET e fornece uma plataforma moderna, rápida e escalável para a criação de aplicativos Web.

Para usar o Dev Proxy com seu aplicativo .NET Aspir, use o pacote NuGet DevProxy.Hosting. O pacote fornece extensões Dev Proxy .NET Aspire para integrar convenientemente o Dev Proxy em seu aplicativo .NET Aspire .

Instale o pacote NuGet das extensões Dev Proxy .NET Aspire

Para instalar o pacote NuGet de extensões do .NET Aspire do Dev Proxy, execute o seguinte comando na pasta raiz do seu aplicativo .NET Aspire :

dotnet add package DevProxy.Hosting

Usando o pacote de extensões Dev Proxy .NET Aspire , você pode integrar o Dev Proxy a partir do executável instalado localmente ou de um contêiner do Docker.

Integre o Dev Proxy a partir do executável instalado localmente

Se você tiver o Dev Proxy instalado localmente, a maneira mais conveniente de integrá-lo ao seu aplicativo .NET Aspire é fazer referência ao executável local. O trecho de código a seguir mostra como integrar o Dev Proxy do executável instalado localmente com o aplicativo inicial .NET Aspire .

Importante

Ao configurar o Proxy de Desenvolvimento para usar o executável local, verifique se o executável está disponível em todas as máquinas em que você executa seu aplicativo. Se você quiser usar o Proxy de Desenvolvimento em um ambiente conteinerizado, considere usar o contêiner do Docker.

using DevProxy.Hosting;

var builder = DistributedApplication
    .CreateBuilder(args);

// Add an API service to the application
var apiService = builder.AddProject<Projects.AspireStarterApp_ApiService>("apiservice")
    .WithHttpsHealthCheck("/health");

var devProxy = builder.AddDevProxyExecutable("devproxy")
    .WithConfigFile(".devproxy/config/devproxy.json")
    .WithUrlsToWatch(() => [$"{apiService.GetEndpoint("https").Url}/*"]);

// Add a web frontend project and configure it to use Dev Proxy
builder.AddProject<Projects.AspireStarterApp_Web>("webfrontend")
    .WithExternalHttpEndpoints()
    .WithHttpsHealthCheck("/health")
    .WithEnvironment("HTTPS_PROXY", devProxy.GetEndpoint(DevProxyResource.ProxyEndpointName))
    .WithReference(apiService)
    .WaitFor(apiService)
    .WaitFor(devProxy);

// Build and run the application
builder.Build().Run();

Primeiro, usando as extensões Dev Proxy .NET Aspire , você adiciona um serviço Dev Proxy ao seu aplicativo. O AddDevProxyExecutable método especifica o nome do executável Dev Proxy. Usando o WithConfigFile método, você especifica o caminho para o arquivo de configuração do Dev Proxy. Usando o método WithUrlsToWatch, tu especificas a lista de URLs a serem observadas. Neste exemplo, você deseja que o Dev Proxy intercete solicitações que o aplicativo Web faz ao serviço de API.

Importante

Observe que o método WithUrlsToWatch aceita uma função que retorna uma lista de URLs para monitorizar. Isso ocorre porque o ponto de extremidade do serviço de API não está disponível quando você configura o Proxy de Desenvolvimento, portanto, não é possível passar a URL diretamente. Em vez disso, você usa uma expressão lambda que retorna a URL do serviço de API quando ele está disponível.

Em seguida, na aplicação web, use a variável de ambiente HTTPS_PROXY para configurar a aplicação web para usar o Proxy de Desenvolvimento. Usando o método WaitFor, você instrui a aplicação web a aguardar que o Proxy de Dev esteja disponível antes de iniciar.

Integrar o Dev Proxy a partir de um contêiner do Docker

Como alternativa, você pode integrar o Dev Proxy em seu aplicativo .NET Aspire a partir de um contêiner do Docker. Usar a imagem do Dev Proxy Docker é conveniente, porque o .NET Aspire puxa automaticamente a imagem se ela não estiver disponível localmente. A desvantagem é que há mais algumas etapas para configurar o Dev Proxy em seu aplicativo.

O trecho de código a seguir mostra como integrar o Dev Proxy de um contêiner do Docker com o aplicativo inicial .NET Aspire .

using DevProxy.Hosting;

var builder = DistributedApplication
    .CreateBuilder(args);

// Add an API service to the application
var apiService = builder.AddProject<Projects.AspireStarterApp_ApiService>("apiservice")
    .WithHttpsHealthCheck("/health");

// Add Dev Proxy as a container resource
var devProxy = builder.AddDevProxyContainer("devproxy")
    // specify the Dev Proxy configuration file; relative to the config folder
    .WithConfigFile("./devproxy.json")
    // mount the local folder with PFX certificate for intercepting HTTPS traffic
    .WithCertFolder(".devproxy/cert")
    // mount the local folder with Dev Proxy configuration
    .WithConfigFolder(".devproxy/config")
    // let Dev Proxy intercept requests to the API service
    .WithUrlsToWatch(() => [$"{apiService.GetEndpoint("https").Url}/*"]);

// Add a web frontend project and configure it to use Dev Proxy
builder.AddProject<Projects.AspireStarterApp_Web>("webfrontend")
    .WithExternalHttpEndpoints()
    .WithHttpsHealthCheck("/health")
    // set the HTTPS_PROXY environment variable to the Dev Proxy endpoint
    .WithEnvironment("HTTPS_PROXY", devProxy.GetEndpoint(DevProxyResource.ProxyEndpointName))
    .WithReference(apiService)
    .WaitFor(apiService)
    .WaitFor(devProxy);

// Build and run the application
builder.Build().Run();

As etapas básicas são as mesmas que ao usar o executável instalado localmente. A principal diferença é como você especifica o arquivo de configuração e o certificado para intercetar o tráfego HTTPS.

Ao integrar o Dev Proxy a partir de um contêiner do Docker, você precisa montar as pastas locais com o arquivo de configuração e o certificado no contêiner. Neste exemplo, na sua solução .NET Aspir, você tem a seguinte estrutura de pastas:

AspireStarterApp
├── .devproxy
│   ├── cert
│   │   └── rootCert.pfx
│   └── config
│       └── devproxy.json
├── Projects
│   ├── AspireStarterApp_ApiService
│   └── AspireStarterApp_Web
└── AspireStarterApp.sln

A cert pasta contém o certificado PFX (Personal Information Exchange) que o Dev Proxy usa para intercetar o tráfego HTTPS.

Importante

Você deve confiar no certificado na cert pasta em sua máquina, ou as solicitações para o serviço de API falharão. Além disso, para que o Dev Proxy carregue o certificado, ele deve estar no formato PFX, deve ser nomeado rootCert.pfxe não deve ser protegido com uma senha.

A config pasta contém o arquivo de configuração do Dev Proxy e outros arquivos do Dev Proxy, como simulações ou erros.

Como você está montando os arquivos de certificado e configuração para separar volumes no contêiner, eles devem ser armazenados em pastas separadas.

Use o Dev Proxy com o aplicativo inicial .NET Aspire

Após abrir a aplicação, o Proxy de Desenvolvimento aparece como um recurso na aplicação.

Quando você usa o aplicativo Web para que ele faça solicitações ao serviço de API, o Dev Proxy interceta as solicitações e manipula de acordo com sua configuração. Você pode ver o output do Dev Proxy na seção Console do dashboard do .NET Aspire.