Vous pouvez personnaliser des aspects de l'interface utilisateur OpenAPI disponible
sur le noeud final /openapi/ui. Liberty
supervise les modifications apportées au fichier CSS de personnalisation
pour traiter et mettre à jour les modifications dans l'interface utilisateur OpenAPI.
Procédure
- Personnalisez le fichier CSS afin d'éditer le style des éléments HTML de la barre d'en-tête de l'interface utilisateur OpenAPI. Ce fichier CSS possède les exigences de format suivantes pour être considéré valide.
- Le fichier CSS spécifie au moins un élément commençant avec .swagger-ui .headerbar.
- Seuls les contenus spécifiés sous les éléments CSS commençant par .swagger-ui .headerbar sont utilisés.
- Le fichier de logo personnalisé qui est référencé par le fichier CSS doit être au format PNG.
- Un fichier de logo personnalisé doit être appelé custom-logo.png et placé sous images/custom-logo.png.
- Le chemin d'accès du fichier de logo doit être relatif au fichier CSS.
- Le fichier CSS doit faire référence au logo avec la propriété background-image définie sur la valeur url(images/custom-logo.png).
Le fragment suivant illustre la substitution d'un fichier CSS :
.swagger-ui .headerbar {
background-color: #5f3345;
}
.swagger-ui .headerbar .headerbar-wrapper {
background-image: url(images/custom-logo.png);
}
- Configurez la surveillance des fichiers pour votre fichier CSS de personnalisation.
Vous pouvez sauvegarder votre fichier CSS personnalisé à l'emplacement
$server.config.dir/mpopenapi/customization.css
pour une surveillance automatique. Si vous souhaitez spécifier un logo personnalisé,
sauvegardez-le à l'emplacement $server.config.dir/mpopenapi/images/custom-logo.png
et référencez-le dans le fichier CSS.
Remarque : Seul le fichier CSS fait l'objet d'une surveillance pour les mises à jour. Le fichier de logo n'est pas surveillé. Toute modification du fichier de logo
doit être suivie d'une mise à jour du fichier CSS pour que la modification soit prise en compte
de façon dynamique.
- Facultatif : Contrôlez la surveillance des fichiers pour les fichiers de personnalisation.
Par défaut, Liberty surveille en continu
le fichier de personnalisation CSS. Cependant, la surveillance du fichier utilise
des ressources système supplémentaires. Vous pouvez modifier la fréquence à laquelle
des mises à jour sont recherchées pour les fichiers surveillés. Si vous ne disposez
pas d'un fichier de personnalisation, il est recommandé de désactiver la surveillance des fichiers.
La propriété de configuration mp.openapi.extensions.liberty.file.polling.interval
spécifique la fréquence à laquelle les mises à jour sont recherchées dans les fichiers surveillés. La valeur de cette propriété est un entier non négatif. L'intervalle est exprimé en secondes. La valeur par défaut est de 2 secondes. Définir la valeur sur 0 désactive la surveillance des fichiers. La configuration est injectée par la spécification MicroProfile Config.
Remarque : La valeur de cette propriété
est vérifiée uniquement quand la fonction mpOpenAPI-1.0 est activée.