Sie können Aspekte der OpenAPI-Benutzerschnittstelle, die am Endpunkt /openapi/ui verfügbar ist, anpassen. Liberty überwacht Änderungen an den angepassten CSS-Dateien, um Änderungen an der OpenAPI-Benutzerschnittstelle zu verarbeiten und zu aktualisieren.
Vorgehensweise
- Passen Sie die CSS-Datei an, um den Stil der HTML-Elemente in der Titelleiste der OpenAPI-Benutzerschnittstelle zu bearbeiten. Diese CSS-Datei hat die folgenden Formatanforderungen, damit sie gültig ist.
- Die CSS-Datei gibt mindestens ein Element an, das mit .swagger-ui .headerbar beginnt.
- Es werden nur die Inhalte verwendet, die für die CSS-Elemente angegeben sind, die mit .swagger-ui .headerbar beginnen.
- Die angepasste Logodatei, die von der CSS-Datei referenziert wird, muss im PNG-Format sein.
- Eine angepasste Logodatei muss den Namen custom-logo.png haben und im Verzeichnis images/custom-logo.png gespeichert werden.
- Der Pfad der Logodatei muss relativ zur CSS-Datei sein.
- Die CSS-Datei muss das Logobild mit der Eigenschaft background-image referenzieren, deren Wert auf url(images/custom-logo.png) gesetzt ist.
Das folgende Snippet veranschaulicht, wie eine CSS-Datei überschrieben wird:
.swagger-ui .headerbar {
background-color: #5f3345;
}
.swagger-ui .headerbar .headerbar-wrapper {
background-image: url(images/custom-logo.png);
}
- Konfigurieren Sie die Dateiüberwachung für Ihre angepasste CSS-Datei.
Sie können Ihre angepasste CSS-Datei an der Position für automatische Überwachung unter $server.config.dir/mpopenapi/customization.css speichern. Wenn Sie außerdem ein angepasstes Logo angeben möchten, speichern Sie es an der Position $server.config.dir/mpopenapi/images/custom-logo.png und verweisen Sie in der CSS-Datei auf das Logo.
Anmerkung: Nur die CSS-Datei wird auf Aktualisierungen überwacht. Die Logodatei wird nicht überwacht. Wenn eine Logodatei geändert wird, muss daraufhin die CSS-Datei aktualisiert werden, damit die Änderung dynamisch wirksam wird.
- Optional: Steuern Sie die Dateiüberwachung für Anpassungsdateien.
Liberty überwacht standardmäßig fortlaufend die angepasste CSS-Datei. Die Überwachung der Datei benötigt jedoch zusätzliche Systemressourcen. Sie können die Häufigkeit, mit der Dateien auf Aktualisierungen überprüft werden, ändern. Wenn Sie keine Anpassungsdatei haben, sollten Sie daher die Dateiüberwachung inaktivieren.
Die Konfigurationseigenschaft mp.openapi.extensions.liberty.file.polling.interval gibt die Häufigkeit an, mit der überwachte Dateien auf Aktualisierungen überprüft werden. Der Wert dieser Eigenschaft ist eine nicht negative Ganzzahl. Die Intervalleinheit ist "Sekunde". Der Standardwert ist 2 Sekunden. Wenn Sie den Wert auf 0 setzen, wird die Dateiüberwachung inaktiviert. Die Konfiguration wird über die MicroProfile-Config-Spezifikation eingefügt.
Anmerkung: Der Wert dieser Eigenschaft wird nur überprüft, wenn das Feature mpOpenAPI-1.0 aktiviert ist.