Partilhar via


TypeSpecGeneratorPlugin

Gera arquivos TypeSpec a partir das solicitações e respostas intercetadas.

Captura de ecrã de duas janelas da linha de comandos. Um mostra solicitações de API de gravação do Dev Proxy. O outro mostra o arquivo TypeSpec gerado.

Definição de instância de plug-in

{
  "name": "TypeSpecGeneratorPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "typeSpecGeneratorPlugin"
}

Exemplo de configuração

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

Propriedades de configuração

Propriedade Descrição Predefinido
ignoreResponseTypes Determina se os tipos para respostas da API (false) devem ser gerados ou definidos como string (true). false

Opções da linha de comandos

Nenhum

Observações

Para criar melhores arquivos TypeSpec, considere usar um modelo de idioma local com o Dev Proxy. Usando um modelo de idioma local, o TypeSpecGeneratorPlugin gera IDs de operação e descrições mais claras, proporcionando um melhor ponto de partida para seu arquivo TypeSpec. Para usar um modelo de idioma local com o TypeSpecGeneratorPlugin, habilite o modelo de idioma no arquivo de configuração. Para obter mais informações, consulte Usar um modelo de idioma local.