OpenApiSpecGeneratorPlugin

Genera especificaciones de OpenAPI en formato JSON a partir de las solicitudes y respuestas interceptadas.

Definición de instancia del complemento

{
  "name": "OpenApiSpecGeneratorPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
  "configSection": "openApiSpecGeneratorPlugin"
}

Ejemplo de configuración

{
  "openApiSpecGeneratorPlugin": {
    "includeOptionsRequests": false
  }
}

Propiedades de configuración

Propiedad	Descripción	Valor predeterminado
includeOptionsRequests	Determina si se deben incluir OPTIONS solicitudes en la especificación de OpenAPI generada.	false

Opciones de línea de comandos

None

Comentarios

Para crear mejores especificaciones de OpenAPI, considere la posibilidad de usar un modelo de lenguaje local con proxy de desarrollo. Con un modelo de lenguaje local, genera OpenApiSpecGeneratorPlugin identificadores de operación y descripciones más claros, lo que le proporciona un mejor punto de partida para la especificación de OpenAPI. Para usar un modelo de lenguaje local con OpenApiSpecGeneratorPlugin, habilite el modelo de lenguaje en el archivo de configuración. Para obtener más información, consulte Uso de un modelo de lenguaje local.