Generare una specifica OpenAPI

Dev Proxy consente di generare una specifica OpenAPI dalle richieste e dalle risposte api intercettate. Usando Dev Proxy è possibile creare rapidamente una specifica OpenAPI per un'API esistente e trarre vantaggio dagli strumenti che supportano OpenAPI.

Per generare una specifica OpenAPI usando Dev Proxy:

1. Nel file di configurazione abilitare il plug-in OpenApiSpecGeneratorPlugin :

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

2. Nel file di configurazione, aggiungere all'elenco di URL da monitorare l'URL dell'API per cui si desidera generare una specifica OpenAPI.

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

   Suggerimento

   Per creare specifiche OpenAPI migliori, è consigliabile usare un modello linguistico locale con Dev Proxy. Per altre informazioni, vedere Usare un modello linguistico locale.

3. Avviare il proxy di sviluppo:

   devproxy
   

4. Avviare la registrazione delle richieste premendo r

5. Eseguire le richieste da includere nella specifica OpenAPI

6. Arrestare le richieste di registrazione premendo s

7. Dev Proxy genera una specifica OpenAPI e la salva in un file nella directory corrente. Dev Proxy assegna un nome al file dopo il nome host dell'API seguito dalla data e dall'ora correnti, ad esempio: api.example.com-20231219091700.json.