Generieren einer TypeSpec-Datei

Dev Proxy ermöglicht es Ihnen, eine TypeSpec-Datei aus den abgefangenen API-Anforderungen und -Antworten zu generieren. Mit Dev Proxy können Sie schnell eine TypeSpec-Datei für eine vorhandene API erstellen und von den Tools profitieren, die TypeSpec unterstützen.

So generieren Sie eine TypeSpec-Datei mit Dev Proxy:

1. Aktivieren Sie in der Konfigurationsdatei das TypeSpecGeneratorPlugin Plug-In:

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

2. Konfigurieren Sie optional das Plug-In in der Konfigurationsdatei:

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

3. Fügen Sie in der Konfigurationsdatei zur Liste der zu überwachenden URLs die URL der API hinzu, für die Sie eine TypeSpec-Datei generieren möchten:

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

   Tipp

   Um bessere TypeSpec-Dateien zu erstellen, sollten Sie ein lokales Sprachmodell mit Dev Proxy verwenden. Mit einem lokalen Sprachmodell generiert typeSpecGeneratorPlugin klarere Vorgangs-IDs und Beschreibungen, sodass Sie einen besseren Ausgangspunkt für Ihre TypeSpec-Datei erhalten. Weitere Informationen finden Sie unter Verwenden eines lokalen Sprachmodells.

4. Dev-Proxy starten:

   devproxy
   

5. Beginnen der Aufzeichnung durch Drücken von r

6. Führen Sie die Anforderungen aus, die Sie in die TypeSpec-Datei aufnehmen möchten.

7. Beenden Sie die Aufzeichnungsanforderungen durch Drücken von s

8. Dev Proxy generiert eine TypeSpec-Datei und speichert sie in einer Datei im aktuellen Verzeichnis. Dev Proxy benennt die Datei nach dem Hostnamen der API, gefolgt vom aktuellen Datum und der aktuellen Uhrzeit, z. B.: api.example.com-20231219091700.tsp.

Nächste Schritte

Erfahren Sie mehr über den TypeSpecGeneratorPlugin.

TypeSpecGeneratorPlugin