Generación de una especificación de OpenAPI
El proxy de desarrollo permite generar una especificación de OpenAPI a partir de las solicitudes y respuestas de api interceptadas. Con el proxy de desarrollo, puede crear rápidamente una especificación de OpenAPI para una API existente y beneficiarse de las herramientas que admiten OpenAPI.
Para generar una especificación de OpenAPI mediante el proxy de desarrollo:
En el archivo de configuración, habilite el
OpenApiSpecGeneratorPlugin
complemento:{ "plugins": [ { "name": "OpenApiSpecGeneratorPlugin", "enabled": true, "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll" } ] // [...] shortened for brevity }
En el archivo de configuración, en la lista de direcciones URL que se van a ver, agregue la dirección URL de la API para la que desea generar una especificación de OpenAPI:
{ "urlsToWatch": [ "https://api.example.com/*", ] // [...] shortened for brevity }
Sugerencia
Para crear mejores especificaciones de OpenAPI, considere la posibilidad de usar un modelo de lenguaje local con proxy de desarrollo. Para obtener más información, consulte Uso de un modelo de lenguaje local.
Iniciar proxy de desarrollo:
devproxy
Iniciar las solicitudes de grabación presionando
r
Realice las solicitudes que desea incluir en la especificación de OpenAPI.
Para detener las solicitudes de grabación presionando
s
Dev Proxy genera una especificación de OpenAPI y la guarda en un archivo del directorio actual. Dev Proxy asigna al archivo el nombre de host de la API seguido de la fecha y hora actuales, por ejemplo:
api.example.com-20231219091700.json
.