Generera en HTTP-fil

Överblick
Mål: Skapa en HTTP-fil från avlyssnade API-begäranden för återanvändning
Tid: 10 minuter
Plugin-program:HttpFileGeneratorPlugin
Krav:Konfigurera Dev Proxy

Med Dev Proxy kan du generera en HTTP-fil från snappade API-begäranden och svar. Att använda HTTP-filer är särskilt användbart för utvecklare som vill simulera API-beteende eller dela reproducerbara API-interaktioner. HTTP-filen innehåller all relevant information om begäran och svar, med känslig information ersatt av variabler för säkerhet och återanvändning.

Så här genererar du en HTTP-fil med dev proxy:

1. I konfigurationsfilen aktiverar du HttpFileGeneratorPlugin:

   Fil: 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. Valfritt kan du konfigurera plugin-programmet genom att lägga till egenskapen includeOptionsRequests i avsnittet httpFileGeneratorPlugin. Den här egenskapen avgör om OPTIONS begäranden ska inkluderas i den genererade HTTP-filen. Standard är false.

3. I konfigurationsfilen i listan över URL:er att titta på lägger du till URL:en för det API som du vill generera en HTTP-fil för.

   Den fullständiga konfigurationsfilen ser ut så här.

   Fil: 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. Starta Dev Proxy:

   devproxy
   

5. Starta inspelningsbegäranden genom att trycka på r.

6. Utför de API-begäranden som du vill inkludera i HTTP-filen.

7. Stoppa inspelningen genom att trycka på s.

8. Dev Proxy genererar en HTTP-fil och sparar den i den aktuella katalogen. Filen innehåller alla insamlade begäranden och svar, med känsliga data som ägartoken och API-nycklar ersatta av variabler. Till exempel:

   @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
   

   Plugin-programmet skapar automatiskt variabler för varje kombination av värdnamn och känslig parameter och återanvänder dem mellan begäranden när det är tillämpligt.

Nästa steg

Läs mer om HttpFileGeneratorPlugin.

HttpFileGeneratorPlugin

Se även

• HttpFileGeneratorPlugin – fullständig referens
• Registrera och exportera proxyaktivitet – Registrera arbetsflöde
• Ordlista – Dev Proxy-terminologi