Gerar um arquivo TypeSpec

De relance
Objetivo: Criar TypeSpec a partir de pedidos intercetados
Tempo: 10 minutos
Plugins:TypeSpecGeneratorPlugin
Pré-requisitos:Configurar o Proxy de Desenvolvimento

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:

   Ficheiro: devproxyrc.json

   {
     "$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"
       }
     ],
     "urlsToWatch": [
       "https://api.example.com/*"
     ],
     "typeSpecGeneratorPlugin": {
       "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/typespecgeneratorplugin.schema.json",
       "ignoreResponseTypes": false
     }
   }
   

2. Opcionalmente, configura a typeSpecGeneratorPlugin secção. Defina ignoreResponseTypes para false (por defeito) para que o plugin gere tipos de resposta.

3. No ficheiro de configuração, à lista de URLs a observar, adicione o URL da API para a qual pretende gerar um ficheiro TypeSpec.

   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.

Consulte também

• Gerar especificação OpenAPI
• Utilizar um modelo de linguagem local
• Atividade de registo e exportação de proxy