Een TypeSpec-bestand genereren

In één oogopslag
Doel: TypeSpec maken van onderschepte aanvragen
Tijd: 10 minuten
Plugins:TypeSpecGeneratorPlugin
Vereisten:Dev Proxy instellen

Met Dev Proxy kunt u een TypeSpec-bestand genereren op basis van de onderschepte API-aanvragen en -antwoorden. Met behulp van Dev Proxy kunt u snel een TypeSpec-bestand voor een bestaande API maken en profiteren van de hulpprogramma's die TypeSpec ondersteunen.

Een TypeSpec-bestand genereren met behulp van Dev Proxy:

1. Schakel in het configuratiebestand de TypeSpecGeneratorPlugin invoegtoepassing in:

   Bestand: devproxyrc.json

   {
     "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.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.0.0/typespecgeneratorplugin.schema.json",
       "ignoreResponseTypes": false
     }
   }
   

2. Configureer desgewenst de typeSpecGeneratorPlugin sectie. Ingesteld ignoreResponseTypes op false (standaard) om de invoegtoepassing antwoordtypen te laten genereren.

3. Voeg in het configuratiebestand aan de lijst met te observeren URL's de URL toe van de API waarvoor u een TypeSpec-bestand wilt genereren.

   Aanbeveling

   Als u betere TypeSpec-bestanden wilt maken, kunt u een lokaal taalmodel gebruiken met Dev Proxy. Met behulp van een lokaal taalmodel genereert de TypeSpecGeneratorPlugin duidelijkere bewerkings-id's en beschrijvingen, waardoor u een beter uitgangspunt voor uw TypeSpec-bestand krijgt. Zie Een lokaal taalmodel gebruiken voor meer informatie.

4. Dev Proxy starten:

   devproxy
   

5. Begin met het opnemen van aanvragen door op r

6. Voer de aanvragen uit die u wilt opnemen in het TypeSpec-bestand

7. Opnameverzoeken stoppen door op te drukken s

8. Dev Proxy genereert een TypeSpec-bestand en slaat het op in een bestand in de huidige map. Dev Proxy noemt het bestand na de hostnaam van de API, gevolgd door de huidige datum en tijd, bijvoorbeeld: api.example.com-20231219091700.tsp

Volgende stappen

Meer informatie over de TypeSpecGeneratorPlugin.

TypeSpecGeneratorPlugin

Zie ook

• OpenAPI-specificatie genereren
• Een lokaal taalmodel gebruiken
• Proxyactiviteit vastleggen en exporteren