Generera en TypeSpec-fil

Överblick
Mål: Skapa TypeSpec från avlyssnade begäranden
Tid: 10 minuter
Plugin-program:TypeSpecGeneratorPlugin
Krav:Konfigurera Dev Proxy

Med Dev Proxy kan du generera en TypeSpec-fil från snappade API-begäranden och svar. Med Dev Proxy kan du snabbt skapa en TypeSpec-fil för ett befintligt API och dra nytta av verktygen som stöder TypeSpec.

Så här genererar du en TypeSpec-fil med dev proxy:

1. Aktivera plugin-programmet i konfigurationsfilen TypeSpecGeneratorPlugin :

   Fil: devproxyrc.json

   {
     "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.2.0/rc.schema.json",
     "plugins": [
       {
         "name": "TypeSpecGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
         "configSection": "typeSpecGeneratorPlugin"
       }
     ],
     "urlsToWatch": [
       "https://api.example.com/*"
     ],
     "typeSpecGeneratorPlugin": {
       "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.2.0/typespecgeneratorplugin.schema.json",
       "ignoreResponseTypes": false
     }
   }
   

2. Valfritt, konfigurera avsnittet typeSpecGeneratorPlugin . Ange ignoreResponseTypes till false (standard) så att plugin-programmet genererar svarstyper.

3. I konfigurationsfilen i listan över URL:er att titta på lägger du till URL:en för det API som du vill generera en TypeSpec-fil för.

   Tips/Råd

   Om du vill skapa bättre TypeSpec-filer bör du överväga att använda en lokal språkmodell med Dev Proxy. Med hjälp av en lokal språkmodell genererar TypeSpecGeneratorPlugin tydligare åtgärds-ID:er och beskrivningar, vilket ger dig en bättre startpunkt för TypeSpec-filen. Mer information finns i Använda en lokal språkmodell.

4. Starta Dev Proxy:

   devproxy
   

5. Starta inspelningsbegäranden genom att trycka på r

6. Utföra de begäranden som du vill inkludera i TypeSpec-filen

7. Stoppa inspelningsbegäranden genom att trycka på s

8. Dev Proxy genererar en TypeSpec-fil och sparar den i en fil i den aktuella katalogen. Dev Proxy namnger filen efter värdnamnet för API:et följt av aktuellt datum och tid, till exempel: api.example.com-20231219091700.tsp.

Nästa steg

Läs mer om TypeSpecGeneratorPlugin.

Se även

• Generera OpenAPI-specifikation
• Använda en lokal språkmodell
• Registrera och exportera proxyaktivitet