HTTP-fájl létrehozása

Egy pillantással
Cél: HTTP-fájl létrehozása elfogt API-kérelmekből újrafelhasználás céljából
Idő: 10 perc
Beépülő modulok:HttpFileGeneratorPlugin
Előfeltételek:Fejlesztői proxy beállítása

A Dev Proxy lehetővé teszi, hogy http-fájlt hozzon létre a lehallgatott API-kérésekből és válaszokból. A HTTP-fájlok használata különösen hasznos azoknak a fejlesztőknek, akik api-viselkedést szeretnének szimulálni, vagy reprodukálható API-interakciókat szeretnének megosztani. A HTTP-fájl tartalmazza az összes vonatkozó kérés- és válaszinformációt, a bizalmas információkat pedig változók helyettesítik a biztonság és az újrahasználhatóság érdekében.

HTTP-fájl létrehozása Dev Proxy használatával:

1. A konfigurációs fájlban engedélyezze a következőt HttpFileGeneratorPlugin:

   Fájl: devproxyrc.json

   {
     "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.3.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.3.0/httpfilegeneratorplugin.schema.json",
       "includeOptionsRequests": false
     }
   }
   

2. Ha szeretné, konfigurálja a beépülő modult úgy, hogy hozzáadja a includeOptionsRequests tulajdonságot a httpFileGeneratorPlugin szakaszhoz. Ez a tulajdonság határozza meg, hogy az OPTIONS kérések szerepeljenek-e a létrehozott HTTP-fájlban. Az alapértelmezett érték false.

3. A konfigurációs fájlban adja hozzá a megtekinteni kívánt URL-címek listájához annak az API-nak az URL-címét, amelyhez HTTP-fájlt szeretne létrehozni.

   A teljes konfigurációs fájl így néz ki.

   Fájl: devproxyrc.json

   {
     "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.3.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.3.0/httpfilegeneratorplugin.schema.json",
       "includeOptionsRequests": false
     }
   }
   

4. Fejlesztői proxy indítása:

   devproxy
   

5. Indítsa el a kérések rögzítését a billentyű lenyomásával r.

6. Hajtsa végre a HTTP-fájlba felvenni kívánt API-kéréseket.

7. Állítsa le a felvételt a billentyű lenyomásával s.

8. A Dev Proxy létrehoz egy HTTP-fájlt, és menti az aktuális könyvtárba. A fájl tartalmazza az összes rögzített kérést és választ, olyan bizalmas adatokkal, mint a tulajdonosi jogkivonatok és az API-kulcsok, amelyeket változók váltanak fel. Például:

   @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
   

   A beépülő modul automatikusan létrehoz változókat a gazdagépnév és a bizalmas paraméterek minden kombinációjához, és szükség esetén újrahasználja őket a kérelmek között.

Következő lépések

További információ a HttpFileGeneratorPluginről.

HttpFileGeneratorPlugin

Lásd még

• HttpFileGeneratorPlugin – Teljes referencia
• Proxytevékenység rögzítése és exportálása – Munkafolyamat rögzítése
• Szószedet – Fejlesztői proxy terminológiája