Criar um plugin personalizado

Neste artigo, você aprenderá a criar um plug-in personalizado para o Dev Proxy. Ao criar plugins para o Dev Proxy, você pode estender sua funcionalidade e adicionar recursos personalizados para atender às suas necessidades.

Pré-requisitos

Antes de começar a criar um plug-in personalizado, certifique-se de ter os seguintes pré-requisitos:

• SDK .NET Core
• A versão mais recente da DLL Dev Proxy Abstractions, que você pode encontrar na página de versões do Dev Proxy GitHub

Criar um novo plugin

Siga as próximas etapas para criar um novo projeto:

1. Crie um novo projeto de biblioteca de classes usando o dotnet new classlib comando.

   dotnet new classlib -n MyCustomPlugin
   

2. Abra o projeto recém-criado no Visual Studio Code.

   code MyCustomPlugin
   

3. Adicione a DLL Dev Proxy Abstractions (dev-proxy-abstractions.dll) à pasta do projeto.

4. Adicione o dev-proxy-abstractions.dll como uma referência ao seu arquivo de projeto DevProxyCustomPlugin.csproj .

   <ItemGroup>
     <Reference Include="dev-proxy-abstractions">
       <HintPath>.\dev-proxy-abstractions.dll</HintPath>
       <Private>false</Private>
       <ExcludeAssets>runtime</ExcludeAssets>
     </Reference>
   </ItemGroup>
   

5. Adicione os pacotes NuGet necessários para o seu projeto.

   dotnet add package Microsoft.Extensions.Configuration
   dotnet add package Microsoft.Extensions.Configuration.Binder
   dotnet add package Microsoft.Extensions.Logging.Abstractions
   dotnet add package Unobtanium.Web.Proxy
   

6. Exclua as DLLs de dependência da saída da compilação adicionando uma ExcludeAssets tag per PackageReference no DevProxyCustomPlugin.csproj arquivo.

   <ExcludeAssets>runtime</ExcludeAssets>
   

7. Crie uma nova classe que implemente a BaseProxyPlugin interface.

   using Microsoft.DevProxy.Abstractions;
   using Microsoft.Extensions.Configuration;
   using Microsoft.Extensions.Logging;
   
   namespace MyCustomPlugin;
   
   public class CatchApiCalls(IPluginEvents pluginEvents, IProxyContext context, ILogger logger, ISet<UrlToWatch> UrlsToWatch, IConfigurationSection? configSection = null) : BaseProxyPlugin(pluginEvents, context, logger, UrlsToWatch, configSection)
   {
     public override string Name => nameof(CatchApiCalls);
   
     public override async Task RegisterAsync()
     {
       await base.RegisterAsync();
   
       PluginEvents.BeforeRequest += BeforeRequestAsync;
     }
   
     private Task BeforeRequestAsync(object sender, ProxyRequestArgs e)
     {
       if (UrlsToWatch is null ||
         !e.HasRequestUrlMatch(UrlsToWatch))
       {
         // No match for the URL, so we don't need to do anything
         Logger.LogRequest("URL not matched", MessageType.Skipped, new LoggingContext(e.Session));
         return Task.CompletedTask;
       }
   
       var headers = e.Session.HttpClient.Request.Headers;
       var header = headers.Where(h => h.Name == "Authorization").FirstOrDefault();
       if (header is null)
       {
         Logger.LogRequest($"Does not contain the Authorization header", MessageType.Warning, new LoggingContext(e.Session));
         return Task.CompletedTask;
       }
   
       return Task.CompletedTask;
     }
   }
   

8. Recompile o seu projeto.

   dotnet build
   

Use seu plugin personalizado

Para usar seu plug-in personalizado, você precisa adicioná-lo ao arquivo de configuração do Dev Proxy:

1. Adicione a nova configuração do devproxyrc.json plugin no arquivo.

   {
     "plugins": [{
       "name": "CatchApiCalls",
       "enabled": true,
       "pluginPath": "./bin/Debug/net8.0/MyCustomPlugin.dll",
     }]
   }
   

2. Execute o proxy de desenvolvimento.

   devproxy
   

O plug-in de exemplo verifica todos os URLs correspondentes para o cabeçalho de Autorização necessário. Se o cabeçalho não estiver presente, ele mostrará uma mensagem de aviso.

Adicionar configuração personalizada ao seu plugin (opcional)

Você pode estender a lógica do seu plug-in adicionando configuração personalizada:

1. Adicione um novo _configuration objeto e associe-o ao Register método.

   using Microsoft.DevProxy.Abstractions;
   using Microsoft.Extensions.Configuration;
   using Microsoft.Extensions.Logging;
   
   namespace MyCustomPlugin;
   
   public class CatchApiCallsConfiguration
   {
     public string? RequiredHeader { get; set; }
   }
   
   public class CatchApiCalls(IPluginEvents pluginEvents, IProxyContext context, ILogger logger, ISet<UrlToWatch> UrlsToWatch, IConfigurationSection? configSection = null) : BaseProxyPlugin(pluginEvents, context, logger, UrlsToWatch, configSection)
   {
     public override string Name => nameof(CatchApiCalls);
   
     // Define you custom configuration
     private readonly CatchApiCallsConfiguration _configuration = new();
   
     public override async Task RegisterAsync()
     {
       await base.RegisterAsync();
   
       // Bind your plugin configuration
       configSection?.Bind(_configuration);
   
       // Register your event handlers
       PluginEvents.BeforeRequest += BeforeRequestAsync;
     }
   
     private Task BeforeRequestAsync(object sender, ProxyRequestArgs e)
     {
       if (UrlsToWatch is null ||
         !e.HasRequestUrlMatch(UrlsToWatch))
       {
         // No match for the URL, so we don't need to do anything
         Logger.LogRequest("URL not matched", MessageType.Skipped, new LoggingContext(e.Session));
         return Task.CompletedTask;
       }
   
       // Start using your custom configuration
       var requiredHeader = _configuration?.RequiredHeader ?? string.Empty;
       if (string.IsNullOrEmpty(requiredHeader))
       {
         // Required header is not set, so we don't need to do anything
         Logger.LogRequest("Required header not set", MessageType.Skipped, new LoggingContext(e.Session));
         return Task.CompletedTask;
       }
   
       var headers = e.Session.HttpClient.Request.Headers;
       var header = headers.Where(h => h.Name == requiredHeader).FirstOrDefault();
       if (header is null)
       {
         Logger.LogRequest($"Does not contain the {requiredHeader} header", MessageType.Warning, new LoggingContext(e.Session));
         return Task.CompletedTask;
       }
   
       return Task.CompletedTask;
     }
   }
   

2. Recompile o seu projeto.

   dotnet build
   

3. Atualize o devproxyrc.json arquivo para incluir a nova configuração.

   {
     "plugins": [{
       "name": "CatchApiCalls",
       "enabled": true,
       "pluginPath": "./bin/Debug/net8.0/MyCustomPlugin.dll",
       "configSection": "catchApiCalls"
     }],
     "catchApiCalls": {
       "requiredHeader": "Authorization" // Example configuration
     }
   }
   

4. Execute o proxy de desenvolvimento.

   devproxy