Generare un file HTTP

Dev Proxy consente di generare un file HTTP da richieste e risposte API intercettate. L'uso di file HTTP è particolarmente utile per gli sviluppatori che vogliono simulare il comportamento dell'API o condividere interazioni API riproducibili. Il file HTTP include tutti i dettagli di richiesta e risposta pertinenti, con informazioni riservate sostituite da variabili per la sicurezza e la riutilizzabilità.

Per generare un file HTTP tramite Dev Proxy:

1. Nel file di configurazione abilitare :HttpFileGeneratorPlugin

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

2. Facoltativamente, configurare il plug-in:

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

   • includeOptionsRequests: determina se includere OPTIONS le richieste nel file HTTP generato. Il valore predefinito è false.

3. Nel file di configurazione, all'elenco degli URL da monitorare, aggiungere l'URL dell'API per la quale si vuole generare un file HTTP.

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

4. Avviare il proxy di sviluppo:

   devproxy
   

5. Avviare la registrazione delle richieste premendo r.

6. Eseguire le richieste API da includere nel file HTTP.

7. Arrestare la registrazione premendo s.

8. Dev Proxy genera un file HTTP e lo salva nella directory corrente. Il file include tutte le richieste e le risposte acquisite, con dati sensibili come token di connessione e chiavi API sostituiti da variabili. Per esempio:

   @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
   

   Il plug-in crea automaticamente variabili per ogni combinazione di nome host e parametro sensibile, riutilizzandoli tra le richieste, se applicabile.

Passaggi successivi

Altre informazioni su HttpFileGeneratorPlugin.

HttpFileGeneratorPlugin