Gerar uma especificação OpenAPI

De relance
Objetivo: Criar uma especificação OpenAPI a partir de pedidos de API intercetados
Tempo: 10 minutos
Plugins:OpenApiSpecGeneratorPlugin
Pré-requisitos:Configurar o Proxy de Desenvolvimento

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

Para gerar uma especificação OpenAPI usando o Dev Proxy:

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

   Ficheiro: devproxyrc.json

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

2. No arquivo de configuração, à lista de URLs a serem observados, adicione a URL da API para a qual você deseja gerar uma especificação OpenAPI:

   Ficheiro: devproxyrc.json

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

   Gorjeta

   Para criar melhores especificações OpenAPI, considere usar um modelo de idioma local com o Dev Proxy. Para obter mais informações, consulte Usar um modelo de idioma local.

3. Inicie o Dev Proxy:

   devproxy
   

4. Comece a gravar solicitações pressionando r

5. Execute as solicitações que você deseja incluir na especificação OpenAPI

6. Pare de gravar solicitações pressionando s

7. O Dev Proxy gera uma especificação OpenAPI e a 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.json.

Consulte também

• OpenApiSpecGeneratorPlugin - Referência completa
• Usar modelo de linguagem local - Melhorar as especificações geradas
• O que é uma especificação OpenAPI - Conceitos
• Glossário - Terminologia de Proxy de Desenvolvimento