Een HTTP-bestand genereren

Met dev Proxy kunt u een HTTP-bestand genereren op basis van onderschepte API-aanvragen en -antwoorden. Het gebruik van HTTP-bestanden is vooral handig voor ontwikkelaars die API-gedrag willen simuleren of reproduceerbare API-interacties willen delen. Het HTTP-bestand bevat alle relevante aanvraag- en antwoordgegevens, waarbij gevoelige informatie wordt vervangen door variabelen voor beveiliging en hergebruik.

Een HTTP-bestand genereren met behulp van Dev Proxy:

1. Schakel in het configuratiebestand het HttpFileGeneratorPluginvolgende in:

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

2. Configureer indien gewenst de invoegtoepassing.

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

   • includeOptionsRequests: bepaalt of de aanvragen opgenomen moeten worden OPTIONS in het gegenereerde HTTP-bestand. De standaardinstelling is false.

3. Voeg in het configuratiebestand aan de lijst met te controleren URL's de URL toe van de API waarvoor u een HTTP-bestand wilt genereren:

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

4. Dev Proxy starten:

   devproxy
   

5. Begin met het opnemen van aanvragen door op te drukken r.

6. Voer de API-aanvragen uit die u wilt opnemen in het HTTP-bestand.

7. Stop opnemen door op te drukken s.

8. Dev Proxy genereert een HTTP-bestand en slaat het op in de huidige map. Het bestand bevat alle vastgelegde aanvragen en antwoorden, waarbij gevoelige gegevens, zoals bearer-tokens en API-sleutels, worden vervangen door variabelen. Voorbeeld:

   @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
   

   De invoegtoepassing maakt automatisch variabelen voor elke combinatie van hostnaam en gevoelige parameter, waarbij deze indien van toepassing opnieuw worden gebruikt voor aanvragen.

Volgende stappen

Meer informatie over de HttpFileGeneratorPlugin.