Dieses Dokument behandelt die folgenden Themen:
Um OpenAPI-Dienste zu erstellen, muss der Natural OpenAPI Server die Definition eines Natural-Subprogramms einlesen. Diese Informationen werden in einer JSON-Datei für den Dienst modelliert und gespeichert.
Jede Dienst-JSON-Datei repräsentiert ein einzelnes Natural-Subprogramm, das die folgenden Informationen enthält:
Name des Natural-Subprogramms und der Natural-Bibliothek.
OpenAPI-Schema-Mappings zwischen OpenAPI-Parametern und Natural-Eingabe- und -Ausgabeparametern.
Abfrageparameter, die ebenfalls auf Natural-Parameter gemappt werden können.
Anmerkung
Abfrageparameter unterstützen derzeit keine Array-Mappings.
Um einen OpenAPI-Dienst zu generieren:
Klicken Sie mit der rechten Maustaste auf das gewünschte Subprogramm.
Wählen Sie Generate OpenAPI Service. Es wird das folgende Menü mit diesen Optionen angezeigt:
Default
Standardeinstellung – Verwendet die im Subprogramm definierte HTTP-Methode.
Ist im Subprogramm keine HTTP-Methode definiert, wird der in den
Preferences konfigurierte Wert verwendet.
GET / POST / PUT / DELETE
Durch die Wahl einer bestimmten HTTP-Methode wird die Standardmethode überschrieben und die
Methode festgelegt, die der Dienst verwenden soll.
Anmerkung
Array-Parameter unterstützen derzeit die HTTP-Methoden GET
und DELETE nicht.
Der OpenAPI Service Editor zeigt Informationen und Konfigurationseinstellungen der Dienste an. Er umfasst drei Registerkarten:
Die Registerkarte Overview zeigt allgemeine Informationen und Konfigurationseinstellungen für den Dienst an.
Auf dieser Registerkarte können Sie außerdem zusätzliche allgemeine Informationen wie Zusammenfassung, Beschreibung und Tags festlegen.
HTTP-Anfragetyp: Gibt die vom Dienst verwendete HTTP-Methode an. Die unterstützten Methoden sind GET, POST, PUT und DELETE.
Verhalten bei zu großem Wert: Legt fest, wie der Dienst mit einem eingehenden OpenAPI-Wert umgeht, der die Größe des entsprechenden zugeordneten Natural-Parameters überschreitet.
Diese Einstellung kann für jeden einzelnen Dienst im Editor konfiguriert werden. Der Standardwert basiert auf der Option, die unter String oversize value handling (Behandlung übergroßer Zeichenfolgenwerte) im Eclipse-Fenster Preferences ausgewählt wurde.
Diese Registerkarte entält im unteren Bereich zwei weitere Registerkarten: Input Parameters und Output Parameters. Die Namen der Properties auf diesen beiden Registerkarten können synchronisiert werden, indem Sie das Kontrollkästchen Synchronize input and output parameter names aktivieren.
Auf dieser Registerkarte wird das OpenAPI-Schema-Layout für die Natural-Eingabeparameter angezeigt. Das Layout bietet eine Zuordnungsschnittstelle (Mapping Interface) zwischen den Natural-Eingabeparametern und dem OpenAPI-Anfrage-Dokument.
Das OpenAPI-Schema-Layout besteht aus drei Bereichen und einem Abschnitt:
OpenAPI Request Document
Linker Baumbereich: Zeigt das OpenAPI-Dokument an. Ein Rechtsklick auf ein
OpenAPI-Element im Baum zeigt die folgenden Optionen an:
Rename
Umbenennen – Ändert den Namen des OpenAPI-Elements.
Restore Mapping
Zuordnung wiederherstellen – Stellt eine zuvor entfernte Zuordnung wieder
her.
Delete
Löschen – Löscht den OpenAPI-Parameter, sofern er derzeit nicht zugeordnet
ist.
Mapping Controls
Bereich Zuordnungssteuerung – Bietet die Möglichkeit, eine Zuordnung zu
entfernen. Das Entfernen einer Zuordnung bedeutet, dass das OpenAPI-Element nicht
mehr verwendet wird. Der entsprechende Natural-Parameter erhält seinen
Standardwert (beispielsweise eine leere Zeichenkette für alphanumerische Parameter
oder 0 für numerische Parameter).
Natural Input Parameters
Rechter Baumbereich – Zeigt die Natural-Parameter an. Ein Rechtsklick auf einen
Natural-Parameter zeigt die folgenden Optionen an:
Map to Document
Im Dokument zuordnen – Erstellt oder stellt eine Zuordnung zu einem Element
des OpenAPI-Dokuments her.
Map to Query Parameter
Zu Abfrageparameter zuordnen – Erstellt einen Abfrageparameter, der dem
Natural-Parameter zugeordnet ist (nur aktiviert, wenn der Natural-Parameter
nicht zugeordnet ist).
Query Parameters
Abschnitt Abfrageparameter: Ermöglicht das Hinzufügen und/oder Entfernen von
Zuordnungen zwischen Abfrageparametern und Natural-Eingabeparametern.
Abfrageparameter werden als Teil der URL übergeben und sind nicht im Hauptteil der
REST-Anfrage enthalten.
Auf dieser Registerkarte wird das OpenAPI-Schema-Layout für die Natural-Ausgabeparameter angezeigt. Das Layout bietet eine Zuordnungsschnittstelle (Mapping Interface) zwischen den Natural-Ausgabeparametern und dem OpenAPI-Antwortdokument.
Auf dieser Registerkarte wird die JSON-Datei des Dienstes angezeigt.
