openapi - OpenAPI (openapi)

Configuración de la característica de OpenAPI.

NameTypeDefaultDescription
customizationstringEspecifica la ubicación de un fragmento de código de OpenAPI para la personalización.
enablePrivateURLbooleanfalseUn valor booleano que controla si se habilitan los puntos finales de documentación de la API privados.
publicURLstring/apiEspecifica la raíz de contexto para los puntos finales de la documentación de la API. El URL no necesita una barra inclinada (/).
validationbooleanfalseUn booleano que controla si los documentos OpenAPI se validan.
disableFileMonitorbooleanfalseUn valor booleano que controla si se supervisan los archivos de personalización.

webModuleDoc

Configuración para cada módulo web que proporciona documentación de la API que se va a exponer.

NameTypeDefaultDescription
idstringUn ID de configuración exclusivo.
contextRootstringLa raíz de contexto del módulo web para el que está proporcionando la documentación.
enabledbooleantrueUn valor booleano que controla el proceso de documentación para este módulo web.
publicbooleantrueUn valor booleano que controla si se muestra el módulo web en la API pública.