Vygenerování specifikace OpenAPI

Na první pohled
Cílem: Vytvoření specifikace OpenAPI z zachycených požadavků rozhraní API
Čas: 10 minut
Pluginy:OpenApiSpecGeneratorPlugin
Požadavky:Nastavení dev proxy serveru

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

Generování specifikace OpenAPI pomocí dev Proxy serveru:

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

   Soubor: devproxyrc.json

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

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

   Soubor: devproxyrc.json

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

   Tip

   Pokud chcete vytvořit lepší specifikace OpenAPI, zvažte použití místního jazykového modelu s dev proxy serverem. Další informace naleznete v tématu Použití místního jazykového modelu.

3. Spustit dev proxy:

   devproxy
   

4. Spusťte zaznamenávání požadavků stisknutím r

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

6. Zastavení nahrávání požadavků stisknutím klávesy s

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

Viz také

• OpenApiSpecGeneratorPlugin – úplný odkaz
• Použití místního jazykového modelu – Vylepšení vygenerovaných specifikací
• Co je specifikace OpenAPI – Koncepty
• Glosář – terminologie dev proxy