Configuración de la característica de OpenAPI.
Name | Type | Default | Description |
---|---|---|---|
customization | string | Especifica la ubicación de un fragmento de código de OpenAPI para la personalización. | |
enablePrivateURL | boolean | false | Un valor booleano que controla si se habilitan los puntos finales de documentación de la API privados. |
publicURL | string | /api | Especifica la raíz de contexto para los puntos finales de la documentación de la API. El URL no necesita una barra inclinada (/). |
validation | boolean | false | Un booleano que controla si los documentos OpenAPI se validan. |
disableFileMonitor | boolean | false | Un valor booleano que controla si se supervisan los archivos de personalización. |
Configuración para cada módulo web que proporciona documentación de la API que se va a exponer.
Name | Type | Default | Description |
---|---|---|---|
id | string | Un ID de configuración exclusivo. | |
contextRoot | string | La raíz de contexto del módulo web para el que está proporcionando la documentación. | |
enabled | boolean | true | Un valor booleano que controla el proceso de documentación para este módulo web. |
public | boolean | true | Un valor booleano que controla si se muestra el módulo web en la API pública. |