Generieren einer HTTP-Datei

Mit Dev Proxy können Sie eine HTTP-Datei aus abgefangenen API-Anforderungen und -Antworten generieren. Die Verwendung von HTTP-Dateien ist besonders nützlich für Entwickler, die DAS API-Verhalten simulieren oder reproduzierbare API-Interaktionen teilen möchten. Die HTTP-Datei enthält alle relevanten Anforderungs- und Antwortdetails, wobei vertrauliche Informationen durch Variablen zur Sicherheit und Wiederverwendbarkeit ersetzt werden.

So generieren Sie eine HTTP-Datei mit Dev Proxy:

1. Aktivieren Sie in der Konfigurationsdatei das HttpFileGeneratorPlugin.

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

2. Konfigurieren Sie optional das 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: Bestimmt, ob OPTIONS Anforderungen in die generierte HTTP-Datei eingeschlossen werden sollen. Der Standardwert ist false.

3. Fügen Sie in der Konfigurationsdatei zur Liste der zu überwachenden URLs die URL der API hinzu, für die Sie eine HTTP-Datei generieren möchten:

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

4. Dev-Proxy starten:

   devproxy
   

5. Starten Sie Aufzeichnungsanforderungen, indem Sie drücken r.

6. Führen Sie die API-Anforderungen aus, die Sie in die HTTP-Datei aufnehmen möchten.

7. Beenden der Aufzeichnung durch Drücken von s.

8. Dev Proxy generiert eine HTTP-Datei und speichert sie im aktuellen Verzeichnis. Die Datei enthält alle erfassten Anforderungen und Antworten, wobei vertrauliche Daten wie Bearertoken und API-Schlüssel durch Variablen ersetzt werden. Beispiel:

   @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
   

   Das Plug-In erstellt automatisch Variablen für jede Kombination aus Hostnamen und vertraulichen Parametern und verwendet diese bei Bedarf über Anforderungen hinweg.

Nächste Schritte

Erfahren Sie mehr über httpFileGeneratorPlugin.

HttpFileGeneratorPlugin