Freigeben über


TypeSpecGeneratorPlugin

Generiert TypeSpec-Dateien aus den abgefangenen Anforderungen und Antworten.

Screenshot von zwei Eingabeaufforderungsfenstern. Eine zeigt Dev Proxy-Aufzeichnungs-API-Anforderungen an. Die andere zeigt die generierte TypeSpec-Datei an.

Konfigurationsbeispiel

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

Konfigurationseigenschaften

Eigentum BESCHREIBUNG Standard
ignoreResponseTypes Legt fest, ob Typen für API-Antworten (false) generiert oder auf string (true) gesetzt werden sollen. false

Befehlszeilenoptionen

Nichts

Bemerkungen

Um bessere TypeSpec-Dateien zu erstellen, sollten Sie ein lokales Sprachmodell mit Dev Proxy verwenden. Durch die Verwendung eines lokalen Sprachmodells werden klarere Vorgangs-IDs und Beschreibungen generiert, TypeSpecGeneratorPlugin sodass Sie einen besseren Ausgangspunkt für Ihre TypeSpec-Datei haben. Um ein lokales Sprachmodell mit dem TypeSpecGeneratorPluginzu verwenden, aktivieren Sie das Sprachmodell in der Konfigurationsdatei. Weitere Informationen finden Sie unter Verwenden eines lokalen Sprachmodells.