Vygenerování souboru TypeSpec

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

Generování souboru TypeSpec pomocí dev proxy serveru:

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

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

2. Volitelně můžete nakonfigurovat modul plug-in v konfiguračním souboru:

   {
     "typeSpecGeneratorPlugin": {
       "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/typespecgeneratorplugin.schema.json",
       "ignoreResponseTypes": false
     }
     // [...] shortened for brevity
   }
   

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

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

   Návod

   Pokud chcete vytvořit lepší soubory TypeSpec, zvažte použití místního jazykového modelu s dev proxy serverem. Pomocí místního jazykového modelu generuje TypeSpecGeneratorPlugin jasnější ID operací a popisy, což vám dává lepší výchozí bod pro váš soubor TypeSpec. Další informace naleznete v tématu Použití místního jazykového modelu.

4. Spustit dev proxy:

   devproxy
   

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

6. Proveďte požadavky, které chcete zahrnout do souboru TypeSpec.

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

8. Dev Proxy vygeneruje soubor TypeSpec a uloží ho 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.tsp.

Další kroky

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

TypeSpecGeneratorPlugin