Condividi tramite


TipoSpecGeneratorPlugin

Genera file TypeSpec dalle richieste e dalle risposte intercettate.

Screenshot di due finestre del prompt dei comandi. Uno mostra le richieste API di registrazione di Dev Proxy. L'altro mostra il file TypeSpec generato.

Esempio di configurazione

{
  "$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
  }
}

Proprietà di configurazione

Proprietà Descrizione Predefinito
ignoreResponseTypes Determina se generare tipi per le risposte API (false) o impostarli su string (true). false

Opzioni della riga di comando

Nessuno

Osservazioni:

Per creare file TypeSpec migliori, è consigliabile usare un modello linguistico locale con Dev Proxy. Utilizzando un modello di lingua locale, genera TypeSpecGeneratorPlugin ID e descrizioni delle operazioni più chiari, offrendo un punto di partenza migliore per il file TypeSpec. Per utilizzare un modello di linguaggio locale con , TypeSpecGeneratorPluginabilitare il modello di linguaggio nel file di configurazione. Per altre informazioni, vedere Usare un modello linguistico locale.