Konfiguration des NaturalONE OpenAPI Plugin

Die globalen Standardeinstellungen für die Generierung von OpenAPI-Diensten können im Eclipse-FensterPreferences konfiguriert werden. Diese Einstellungen gelten für alle vom Plugin generierten Dienstdateien.

To access these settings, go to Window on the main menu and select Preferences. On the navigation tree, expand the Software AG node, Natural node, and then select OpenAPI.

Um auf diese Einstellungen zuzugreifen, wählen Sie im Hauptmenü Window und dann Preferences. Wählen Sie in dem Verzeichnis unter dem Knoten Software AG den Knoten Natural und wählen Sie anschließend OpenAPI.

Eclipse Preferences window

Die Einstellungen im Fenster Preferences legen die Standardwerte fest, die bei der Generierung von OpenAPI-Diensten verwendet werden, wenn eine entsprechende Property im Subprogramm selbst nicht explizit definiert wurde.

Die folgenden Einstellungen sind verfügbar:

Use lowercase letters

Aktivieren Sie dieses Kontrollkästchen, um Parameternamen während der Generierung von OpenAPI-Diensten automatisch in Kleinbuchstaben umzuwandeln.

API parameter name transformation

Diese Einstellung bietet Optionen zur automatischen Umwandlung von OpenAPI-Parameternamen. Die folgenden Optionen sind verfügbar:

  • Keep API parameter names
    Bei Wahl dieser Option bleiben die Parameternamen unverändert.

  • Remove characters
    Bei Wahl dieser Option werden bestimmte Zeichen aus den Parameternamen entfernt. In einem zugehörigen Eingabefeld können Sie die zu entfernenden Zeichen angeben (z. B. #, ! oder @).

  • Replace characters
    Bei Wahl dieser Option können Sie Zuordnungen (Mappings) definieren, die festlegen, welche Zeichen oder Zeichenfolgen ersetzt werden sollen und welche Zeichen oder Zeichenfolgen anstelle der zu entfernenden Zeichen als Ersatz verwendet werden sollen.

String oversize value handling

Diese Einstellung legt das Standardverhalten bei der Behandlung überlanger Zeichenfolgenwerte fest. Diese Einstellung kann für einen einzelnen Dienst im OpenAPI-Editor überschrieben werden.

Die folgenden Optionen stehen zur Verfügung:

  • Truncate
    Diese Option kürzt den Wert, wenn er die zulässige Größe überschreitet.

  • Error
    Diese Option löst einen Fehler aus, wenn der Wert die zulässige Größe überschreitet.

Default HTTP request type

Diese Einstellung legt die Standard-HTTP-Anfragemethode fest, die beim Öffnen des OpenAPI-Editors ausgewählt wird, sofern im Subprogramm kein HTTP-Anfragetyp definiert wurde.

Open OpenAPI service editor after generating JSON file

OpenAPI-Service-Editor nach der Erstellung der JSON-Datei öffnen.

Diese Einstellung legt fest, ob der OpenAPI-Editor automatisch geöffnet wird, wenn die Funktion Generate OpenAPI Service ausgelöst wird.

Standardmäßig ist dieses Kontrollkästchen aktiviert. Ist es deaktiviert, wird die Service-Datei sofort erstellt, ohne dass der Editor geöffnet wird.

Wenn mehrere Subprogramme ausgewählt sind und die Funktion Generate OpenAPI Service ausgelöst wird, wird diese Einstellung umgangen und der OpenAPI-Editor nicht geöffnet.