Puede personalizar aspectos de la interfaz de usuario OpenAPI disponibles en el punto final
/openapi/ui. Liberty supervisa
los cambios en el archivo CSS de personalización para procesar y actualizar cambios en la IU de OpenAPI.
Procedimiento
- Personalice el archivo CSS para editar el estilo de los elementos HTML en la barra de cabecera
de la IU de OpenAPI. Este archivo CSS tiene los requisitos de formato siguientes que se deben considerar válidos.
- El archivo CSS especifica, al menos, un elemento que empieza con .swagger-ui
.headerbar.
- Solo se utilizan los contenidos que se especifican bajo elementos CSS que empiezan con .swagger-ui
.headerbar.
- El archivo de logotipo personalizado referenciado por el archivo CSS debe estar en formato PNG.
- Un archivo de logotipo personalizado debe denominarse custom-logo.png y debe colocarse en images/custom-logo.png.
- La vía de acceso del archivo de logotipo debe ser relativa al archivo CSS.
- El archivo CSS debe hacer referencia a la imagen de logotipo con la propiedad background-image establecida en el valor url(images/custom-logo.png).
El fragmento de código siguiente ilustra cómo alterar temporalmente un archivo CSS:
.swagger-ui .headerbar {
background-color: #5f3345;
}
.swagger-ui .headerbar .headerbar-wrapper {
background-image: url(images/custom-logo.png);
}
- Configure la supervisión de archivos para el archivo CSS de personalización.
Puede guardar el archivo CSS personalizado en la ubicación
$server.config.dir/mpopenapi/customization.css para
la supervisión automática. Si también desea especificar un logotipo personalizado, guárdelo en la
ubicación $server.config.dir/mpopenapi/images/custom-logo.png
y haga referencia a él en el archivo CSS.
Nota: Sólo se supervisan las actualizaciones en el archivo CSS. El archivo de logotipo no se supervisa. Un cambio en el archivo de logotipo debe ir seguido de una actualización en el archivo CSS para que se
seleccione dinámicamente.
- Opcional: Supervisión de archivo de control para archivos de personalización.
Liberty supervisa continuamente el
archivo de personalización CSS de forma predeterminada. Sin embargo, la supervisión del archivo utiliza
recursos de sistema adicionales. Puede modificar la frecuencia con la que se comprueban las
actualizaciones en los archivos supervisados. Si no tiene ningún archivo de personalización,
es beneficioso desactivar la supervisión de archivos.
La propiedad de configuración
mp.openapi.extensions.liberty.file.polling.interval especifica con qué frecuencia
se comprueban las actualizaciones en los archivos supervisados. El valor de esta propiedad es
un entero no negativo. La unidad para el intervalo son los segundos. El valor predeterminado es
2 segundos. Al establecer el valor en 0, se inhabilita la supervisión de archivos. La
especificación de MicroProfile Config inyecta la configuración.
Nota: El
valor de esta propiedad sólo se comprueba cuando se habilita la característica mpOpenAPI-1.0.