Compartilhar via


TypeSpecGeneratorPlugin

Gera arquivos TypeSpec das solicitações e respostas interceptadas.

Captura de tela de duas janelas de prompt de comando. Uma delas mostra o Dev Proxy gravando solicitações de API. A outra mostra o arquivo TypeSpec gerado.

Definição da instância do 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 Padrão
ignoreResponseTypes Determina se os tipos devem ser gerados para respostas da API (false) ou definidos como string (true). false

Opções de linha de comando

Nenhum

Observações

Para criar arquivos TypeSpec melhores, considere usar um modelo de idioma local com o Proxy Dev. Usando um modelo de idioma local, o TypeSpecGeneratorPlugin gera IDs e descrições de operação mais claras, fornecendo um ponto de partida melhor para o 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.