Betrieb

Dieses Dokument behandelt die folgenden Themen:

Bereitstellung der Webanwendung mit Liberty

Im Folgenden finden Sie einige spezifische Konfigurationen für Liberty, falls Sie die Natural OpenAPI-Webanwendung mit Ihrem eigenen Liberty bereitstellen möchten.

Bereitstellung der War-Datei

Die Datei NaturalOpenAPIServer.war muss in das Verzeichnis /config/apps/ kopiert werden.

Konfiguration der Datei Server.XML

Die folgende Konfiguration sollte zur Datei server.xml hinzugefügt werden, um den Natural OpenAPI Server bereitzustellen.

Zusätzlich muss die Umgebungsvariable SPRING_CONFIG_LOCATION konfiguriert werden, damit sie auf den Speicherort der Datei application.properties zeigt. 

<?xml version="1.0" encoding="UTF-8"?>
                <server description="Natural _OpenAPI">
                
                <featureManager>
                <feature>servlet-6.0</feature>
                <feature>mpConfig-3.1</feature>
                </featureManager>
                
                <httpEndpoint id="defaultHttpEndpoint" httpPort="9080" httpsPort="9443"/>
                
                <!--
                appProperties is Liberty's per-application config mechanism: values here
                are scoped strictly to the <webApplication> that declares them and are
                exposed through MicroProfile Config - MpConfigEnvironmentInitializer in
                the app reads them from there.
                -->
                <webApplication id="app1" name="app1" location="/config/apps/NaturalOpenAPIServer.war" contextRoot="/app1">
                <appProperties>
                <property name="SPRING_CONFIG_LOCATION" value="file:///config/application.properties"/>
                </appProperties>
                </webApplication>
                </server>

Bereitstellung von OpenAPI-Ressourcen

Um die im Abschnitt Developer Overview > Generating OpenAPI Resources beschriebenen Dienste bereitzustellen, muss der Natural OpenAPI Server mit dem Speicherort der Dienstdateien konfiguriert werden.

Der Speicherort der Dienstdateien kann auf folgende Weise konfiguriert werden:

  • Unter Verwendung von natural.integration.services.directory – Legen Sie diese Property in der Datei application.properties fest, um das Verzeichnis anzugeben, das die Dienstdateien enthält. Speichern Sie die Dienstdateien in dem angegebenen Verzeichnis.

  • Unter Verwendung von natural.integration.services.files – Legen Sie diese Property fest, um die Namen der spezifischen Dienstdateien anzugeben, die bereitgestellt werden sollen. Die angegebenen Dateien müssen sich im Class-Pfad der Anwendung befinden.

Beim Start des Natural OpenAPI-Servers werden die konfigurierten Dienstdateien geladen und die darin definierten OpenAPI-Dienste registriert.

Jede Dienstdatei enthält die Definitionen und Mapping-Informationen, die erforderlich sind, um ein Natural-Subprogramm als REST API-Dienst bereitzustellen. Sobald der Server erfolgreich gestartet wurde, stehen alle in den geladenen Dienstdateien definierten Dienste den Clients über den Natural OpenAPI Server zur Verfügung. Weitere Informationen finden Sie unter dem Parameter management.endpoints.web.exposure.include im Abschnitt Allgemeine Konfiguration.

Um einen Dienst hinzuzufügen oder zu ändern, muss daher die entsprechende Dienstdatei aktualisiert und der Server neu gestartet werden oder der Reload-Actuator-Endpunkt verwendet werden, um die Änderungen zu laden und die Dienste verfügbar zu machen.

On this page