Generación de un archivo HTTP

El proxy de desarrollo permite generar un archivo HTTP a partir de solicitudes y respuestas de API interceptadas. El uso de archivos HTTP es especialmente útil para los desarrolladores que desean simular el comportamiento de la API o compartir interacciones de API reproducibles. El archivo HTTP incluye todos los detalles de solicitud y respuesta pertinentes, con información confidencial reemplazada por variables para la seguridad y reutilización.

Para generar un archivo HTTP mediante el proxy de desarrollo:

1. En el archivo de configuración, habilite el HttpFileGeneratorPlugin.

   {
     "plugins": [
       {
         "name": "HttpFileGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
         "configSection": "httpFileGeneratorPlugin"
       }
     ]
     // [...] shortened for brevity
   }
   

2. Opcionalmente, configure el complemento:

   {
     "httpFileGeneratorPlugin": {
       "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.29.2/httpfilegeneratorplugin.schema.json",
       "includeOptionsRequests": false
     }
     // [...] shortened for brevity
   }
   

   • includeOptionsRequests: determina si se deben incluir OPTIONS solicitudes en el archivo HTTP generado. El valor predeterminado es false.

3. En el archivo de configuración, en la lista de direcciones URL que se van a ver, agregue la dirección URL de la API para la que desea generar un archivo HTTP:

   {
     "urlsToWatch": [
       "https://api.example.com/*"
     ]
     // [...] shortened for brevity
   }
   

4. Iniciar proxy de desarrollo:

   devproxy
   

5. Inicie las solicitudes de grabación presionando r.

6. Realice las solicitudes de API que desea incluir en el archivo HTTP.

7. Detenga la grabación presionando s.

8. Dev Proxy genera un archivo HTTP y lo guarda en el directorio actual. El archivo incluye todas las solicitudes y respuestas capturadas, con datos confidenciales, como tokens de portador y claves de API reemplazadas por variables. Por ejemplo:

   @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
   

   El complemento crea automáticamente variables para cada combinación de nombre de host y parámetro confidencial, reutilizándolas entre solicitudes cuando corresponda.

Pasos siguientes

Obtenga más información sobre HttpFileGeneratorPlugin.