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:
Nel file di configurazione abilitare il plug-in
OpenApiSpecGeneratorPlugin
:{ "plugins": [ { "name": "OpenApiSpecGeneratorPlugin", "enabled": true, "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll" } ] // [...] shortened for brevity }
Nel file di configurazione aggiungere l'URL dell'API per cui si vuole 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.
Avviare il proxy di sviluppo:
devproxy
Avviare la registrazione delle richieste premendo
r
Eseguire le richieste da includere nella specifica OpenAPI
Arrestare le richieste di registrazione premendo
s
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
.
Feedback su Dev Proxy
Dev Proxy è un progetto di open source. Selezionare un collegamento per fornire feedback: