Importieren eines OpenAPI (Swagger) Dokuments, um einen Endpunkt im Jitterbit App Builder zu erstellen

Einführung

Seit Version 4.45 können Sie einen REST-Endpunkt aus einem OpenAPI (Swagger) Dokument erstellen. Der App Builder verwendet die OpenAPI.net-Bibliothek und unterstützt Dokumentversionen von Swagger 2.0 bis OpenAPI 3.1 einschließlich.

Sie können einen Endpunkt von einem dieser Orte aus erstellen:

• IDE > Datenserver

• App-Arbeitsbereich > Datenquellen

Diese Seite zeigt die Schritte für beide.

Erstellen eines REST-Endpunkts aus einem OpenAPI (Swagger) Dokument über die IDE

Befolgen Sie diese Schritte:

1. Wählen Sie IDE > Datenserver.

2. Klicken Sie auf die Schaltfläche + Server. Der Dialog Server öffnet sich.

3. Setzen Sie Werte für Folgendes:

   • Servername: Geben Sie einen Namen für den Server ein.

   • Typ: Wählen Sie REST API. (REST wird automatisch für Untertyp ausgewählt.)

   • URL: Geben Sie die Endpunkt-Root (Basis-URL) ein.

   • (Optional) Beschreibung: Geben Sie eine Beschreibung ein.

4. Klicken Sie auf die Schaltfläche Speichern.

   Das folgende Beispiel verwendet die OpenAPI-Testdokument-URL https://ipinfo.io/developers/openapi.yaml:

   

5. Klicken Sie im Dialog Server auf das Symbol Endpunkte.

6. Klicken Sie im Panel Webdienst auf die Schaltfläche Importieren. Die erste Seite des Dialogs des Webdienst-Import-Assistenten öffnet sich:

   

7. Wählen Sie einen der folgenden Tabs, je nachdem, wie Sie Ihr Dokument bereitstellen möchten:

   • URL: Wählen Sie, um eine URL für das Dokument bereitzustellen.

   • Dokument: Wählen Sie, um den Inhalt eines Dokuments einzufügen.

8. Hochladen: Wählen Sie aus, um ein Dokument von Ihrem Dateisystem hochzuladen.

9. Klicken Sie auf die Weiter-Schaltfläche. Die zweite Seite des Dialogs des Web Service Import-Assistenten öffnet sich:

   

10. (Optional) Um einen oder mehrere Endpunkte zu importieren, tun Sie Folgendes:

    • Geben Sie ein Muster im Feld Importieren nach Name ein und klicken Sie dann auf die Importieren-Schaltfläche.

      Ein Muster ist eine durch Kommas getrennte Liste von Platzhalterausdrücken, die eine Teilmenge von Tabellen zum Importieren auswählen. Jedes Muster verwendet die mvSQL LIKE-Syntax. Sie können % verwenden, um null oder mehr Zeichen zuzuordnen, und _, um ein einzelnes Zeichen zuzuordnen. Zeichen in eckigen Klammern (zum Beispiel [abc]) entsprechen jedem Zeichen in der Gruppe.

    • Klicken Sie auf eine der Schema importieren-Schaltflächen, um Endpunkte zu importieren.

11. Klicken Sie auf die Fertigstellen-Schaltfläche.

Erstellen Sie einen REST-Endpunkt aus einem OpenAPI (Swagger) Dokument über das App Workbench

Befolgen Sie diese Schritte:

1. Wählen Sie App Workbench aus dem Aktionsbereich oder Workbench aus dem Anwendungsmenü und klicken Sie dann auf Datenquellen.

2. Klicken Sie auf die + Quelle-Schaltfläche. Der Dialog Eine Quelle zu Ihrer Anwendung hinzufügen öffnet sich.

3. Wählen Sie die Option Neue Verbindung und klicken Sie dann auf die Weiter-Schaltfläche. Die Assistentenseite Verbindungstyp auswählen öffnet sich.

4. Wählen Sie unter Verbindungskategorie die Option REST.

5. Wählen Sie unter Arten von Verbindungen die Option REST API und klicken Sie dann auf die Weiter-Schaltfläche.

6. Wählen oder richten Sie einen Sicherheitsanbieter ein, oder klicken Sie auf die Überspringen-Schaltfläche. Die Assistentenseite Neue Verbindung erstellen öffnet sich.

7. Klicken Sie auf die Importieren-Schaltfläche. Der Dialog Neue Verbindung importieren öffnet sich:

   

8. Wählen Sie einen der folgenden Tabs, je nachdem, wie Sie Ihr Dokument bereitstellen möchten:

   • URL: Wählen Sie aus, um eine URL für das Dokument bereitzustellen.
   • Dokument: Wählen Sie aus, um den Inhalt eines Dokuments einzufügen.
   • Hochladen: Wählen Sie aus, um ein Dokument von Ihrem Dateisystem hochzuladen.

9. Klicken Sie auf die Weiter-Schaltfläche. Der Dialog Endpunkte erstellen öffnet sich:

   

10. Klicken Sie auf die Import-Schaltfläche. Der Dialog Webdienst-Import öffnet sich erneut:

    

11. Klicken Sie auf die Weiter-Schaltfläche.

12. (Optional) Um einen oder mehrere Endpunkte zu importieren, tun Sie eines der Folgenden:

    • Geben Sie ein Muster im Feld Nach Namen importieren ein und klicken Sie dann auf die Import-Schaltfläche.

      Ein Muster ist eine durch Kommas getrennte Liste von Platzhalterausdrücken, die eine Teilmenge von Tabellen auswählen, die importiert werden sollen. Jedes Muster verwendet die mvSQL LIKE-Syntax. Sie können % verwenden, um null oder mehr Zeichen zu entsprechen, und _, um ein einzelnes Zeichen zu entsprechen. Zeichen in eckigen Klammern (zum Beispiel [abc]) entsprechen jedem Zeichen in der Gruppe.

    • Klicken Sie auf eine der Schema importieren-Schaltflächen, um Endpunkte zu importieren.

13. Klicken Sie auf die Fertig-Schaltfläche. Die Seite des Assistenten Endpunkte erstellen erscheint erneut:

    

14. Um die Endpunkte zu testen, klicken Sie auf eines der -Symbole in der Status-Spalte. Bei Erfolg ändert sich das Symbol in :

    

15. Klicken Sie auf die Weiter-Schaltfläche. Der Dialog Zusammenfassung der neuen Datenquelle öffnet sich:

    

16. Klicken Sie auf die Fertig-Schaltfläche.