Vygenerování souboru HTTP

Na první pohled
Cílem: Vytvoření souboru HTTP z zachycených požadavků rozhraní API pro opakované použití
Čas: 10 minut
Pluginy:HttpFileGeneratorPlugin
Požadavky:Nastavení dev proxy serveru

Dev Proxy umožňuje vygenerovat soubor HTTP z zachycených požadavků a odpovědí rozhraní API. Použití souborů HTTP je užitečné zejména pro vývojáře, kteří chtějí simulovat chování rozhraní API nebo sdílet reprodukovatelné interakce rozhraní API. Soubor HTTP obsahuje všechny relevantní podrobnosti požadavku a odpovědi s citlivými informacemi nahrazenými proměnnými pro zabezpečení a opakované použití.

Generování souboru HTTP pomocí dev Proxy serveru:

1. V konfiguračním souboru povolte HttpFileGeneratorPlugin:

   Soubor: 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. Volitelně můžete modul plug-in nakonfigurovat přidáním includeOptionsRequests vlastnosti do oddílu httpFileGeneratorPlugin . Tato vlastnost určuje, zda zahrnout OPTIONS požadavky do vygenerovaného souboru HTTP. Výchozí hodnota je false.

3. V konfiguračním souboru přidejte do seznamu adres URL, které chcete sledovat, adresu URL rozhraní API, pro které chcete vygenerovat soubor HTTP.

   Úplný konfigurační soubor vypadá takto.

   Soubor: 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. Spustit dev proxy:

   devproxy
   

5. Začněte zaznamenávat žádosti stisknutím klávesy r.

6. Proveďte požadavky rozhraní API, které chcete zahrnout do souboru HTTP.

7. Zastavte nahrávání stisknutím klávesy s.

8. Dev Proxy vygeneruje soubor HTTP a uloží ho do aktuálního adresáře. Soubor obsahuje všechny zachycené požadavky a odpovědi s citlivými daty, jako jsou nosné tokeny a klíče rozhraní API nahrazené proměnnými. Například:

   @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
   

   Modul plug-in automaticky vytvoří proměnné pro každou kombinaci názvu hostitele a citlivého parametru a v případě potřeby je opakovaně používá napříč požadavky.

Další kroky

Přečtěte si další informace o httpFileGeneratorPlugin.

HttpFileGeneratorPlugin

Viz také

• HttpFileGeneratorPlugin – úplný odkaz
• Zaznamenání a export aktivity proxy – Nahrávací pracovní postup
• Glosář – terminologie dev proxy