Gerar um arquivo TypeSpec

O Proxy de Desenvolvimento permite que você gere um arquivo TypeSpec das solicitações e respostas da API interceptadas. Usando o Proxy de Desenvolvimento, você pode criar rapidamente um arquivo TypeSpec para uma API existente e se beneficiar das ferramentas que dão suporte ao TypeSpec.

Para gerar um arquivo TypeSpec usando o Proxy de Desenvolvimento:

1. No arquivo de configuração, habilite o TypeSpecGeneratorPlugin plug-in:

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

2. Opcionalmente, configure o plug-in no arquivo de configuração:

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

3. No arquivo de configuração, à lista de URLs a serem exibidas, adicione a URL da API para a qual você deseja gerar um arquivo TypeSpec:

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

   Dica

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

4. Iniciar Proxy de Desenvolvimento:

   devproxy
   

5. Iniciar a gravação de solicitações pressionando r

6. Executar as solicitações que você deseja incluir no arquivo TypeSpec

7. Parar a gravação de solicitações pressionando s

8. O Proxy de Desenvolvimento gera um arquivo TypeSpec e o salva em um arquivo no diretório atual. O Proxy de Desenvolvimento nomeia o arquivo após o nome do host da API seguido pela data e hora atuais, por exemplo: api.example.com-20231219091700.tsp.

Próximas etapas

Saiba mais sobre o TypeSpecGeneratorPlugin.

TypeSpecGeneratorPlugin