Gerar um arquivo TypeSpec

O Dev Proxy permite gerar um arquivo TypeSpec a partir das solicitações e respostas de API intercetadas. Usando o Dev Proxy, você pode criar rapidamente um arquivo TypeSpec para uma API existente e se beneficiar das ferramentas que suportam TypeSpec.

Para gerar um arquivo TypeSpec usando o Dev Proxy:

1. No arquivo de configuração, ative o TypeSpecGeneratorPlugin plugin:

   {
     "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 observados, adicione a URL da API para a qual você deseja gerar um arquivo TypeSpec:

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

   Sugestão

   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, dando-lhe um melhor ponto de partida para o seu arquivo TypeSpec. Para obter mais informações, consulte Usar um modelo de idioma local.

4. Inicie o Dev Proxy:

   devproxy
   

5. Comece a gravar solicitações pressionando r

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

7. Pare de gravar solicitações pressionando s

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

Próximos passos

Saiba mais sobre o TypeSpecGeneratorPlugin.

TypeSpecGeneratorPlugin