Vygenerování specifikace OpenAPI

Dev Proxy umožňuje vygenerovat specifikaci OpenAPI ze zachycených požadavků a odpovědí rozhraní API. Pomocí vývojového proxy serveru můžete rychle vytvořit specifikaci OpenAPI pro stávající rozhraní API a využívat výhody nástrojů, které podporují OpenAPI.

Postup vygenerování specifikace OpenAPI pomocí vývojového proxy serveru:

1. V konfiguračním souboru povolte modul plug-in OpenApiSpecGeneratorPlugin :

   {
     "plugins": [
       {
         "name": "OpenApiSpecGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll"
       }
     ]
     // [...] shortened for brevity
   }
   

2. V konfiguračním souboru do seznamu adres URL pro watch přidejte adresu URL rozhraní API, pro které chcete vygenerovat specifikaci OpenAPI:

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

3. Spusťte proxy vývoj bez neúspěšných požadavků:

   devproxy --failure-rate 0
   

4. Začněte zaznamenávat žádosti stisknutím tlačítka r

5. Proveďte požadavky, které chcete zahrnout do specifikace OpenAPI.

6. Zastavte nahrávání žádostí stisknutím s

7. Dev Proxy vygeneruje specifikaci OpenAPI a uloží ji do souboru v aktuálním adresáři. Dev Proxy pojmenuje soubor za názvem hostitele rozhraní API, za nímž následuje aktuální datum a čas, například: api.example.com-20231219091700.json.