Gerar um arquivo HTTP

De relance
Objetivo: Criar um ficheiro HTTP a partir de pedidos de API intercetados para reutilização
Tempo: 10 minutos
Plugins:HttpFileGeneratorPlugin
Pré-requisitos:Configurar o Proxy de Desenvolvimento

O Dev Proxy permite gerar um arquivo HTTP a partir de solicitações e respostas de API intercetadas. O uso de arquivos HTTP é especialmente útil para desenvolvedores que desejam simular o comportamento da API ou compartilhar interações reproduzíveis da API. O arquivo HTTP inclui todos os detalhes relevantes de solicitação e resposta, com informações confidenciais substituídas por variáveis de segurança e reutilização.

Para gerar um arquivo HTTP usando o Dev Proxy:

1. No arquivo de configuração, habilite o HttpFileGeneratorPlugin:

   Ficheiro: devproxyrc.json

   {
     "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/rc.schema.json",
     "plugins": [
       {
         "name": "HttpFileGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
         "configSection": "httpFileGeneratorPlugin"
       }
     ],
     "urlsToWatch": [
       "https://api.example.com/*"
     ],
     "httpFileGeneratorPlugin": {
       "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/httpfilegeneratorplugin.schema.json",
       "includeOptionsRequests": false
     }
   }
   

2. Opcionalmente, configure o plugin adicionando a includeOptionsRequests propriedade à httpFileGeneratorPlugin secção. Esta propriedade determina se deve incluir OPTIONS pedidos no ficheiro HTTP gerado. A predefinição é false.

3. No ficheiro de configuração, à lista de URLs a observar, adicione o URL da API para a qual pretende gerar um ficheiro HTTP.

   O ficheiro de configuração completo está assim.

   Ficheiro: devproxyrc.json

   {
     "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/rc.schema.json",
     "plugins": [
       {
         "name": "HttpFileGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
         "configSection": "httpFileGeneratorPlugin"
       }
     ],
     "urlsToWatch": [
       "https://api.example.com/*"
     ],
     "httpFileGeneratorPlugin": {
       "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/httpfilegeneratorplugin.schema.json",
       "includeOptionsRequests": false
     }
   }
   

4. Inicie o Dev Proxy:

   devproxy
   

5. Comece a gravar solicitações pressionando r.

6. Execute as solicitações de API que você deseja incluir no arquivo HTTP.

7. Pare a gravação pressionando s.

8. O Dev Proxy gera um arquivo HTTP e o salva no diretório atual. O arquivo inclui todas as solicitações e respostas capturadas, com dados confidenciais, como tokens de portador e chaves de API, substituídos por variáveis. Por exemplo:

   @jsonplaceholder_typicode_com_api_key = api-key
   ###
   # @name getPosts
   GET https://jsonplaceholder.typicode.com/posts?api-key={{jsonplaceholder_typicode_com_api_key}}
   Host: jsonplaceholder.typicode.com
   User-Agent: curl/8.6.0
   Accept: */*
   Via: 1.1 dev-proxy/0.29.0
   

   O plugin cria automaticamente variáveis para cada combinação de nome de host e parâmetro sensível, reutilizando-as entre solicitações quando aplicável.

Próximos passos

Saiba mais sobre o HttpFileGeneratorPlugin.

Consulte também

• HttpFileGeneratorPlugin - Referência completa
• Gravar e exportar atividade de proxy - Fluxo de trabalho de gravação
• Glossário - Terminologia de Proxy de Desenvolvimento