OpenAPI-Unterstützung im REST-Schritt

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 3 Minuten Lesedauer

    • Füllen Sie REST-Schrittfelder und Aktionseingaben mit aus einer OpenAPI-Spezifikation importierten Informationen aus. Importieren Sie Spezifikationen, indem Sie eine URL für YAML oder JSON bereitstellen oder Inhalte kopieren und einfügen.

    Vorteile

    Die OpenAPI-Unterstützung im REST-Schritt bietet diese Vorteile.

    • Verwenden Sie Informationen, die aus einer OpenAPI-Spezifikation importiert wurden, um REST-Schrittvorgänge, HTTP-Methoden, Parameter, Anforderungstext, Pfad zu konfigurieren. und-Header.
    • Überprüfen Sie verfügbare API-Vorgänge, ohne die Flow Designer-Schnittstelle zu verlassen.
    • Generieren Sie Eingaben, die für den REST-Schritt erforderlich sind, um gültige Anforderungen an einen OpenAPI-Service zu senden, und fügen Sie sie dem REST-Schritt an der richtigen Stelle hinzu.
    Hinweis:
    Überprüfen Sie immer REST-Schrittwerte, die aus einer OpenAPI-Spezifikation importiert wurden, bevor Sie eine Anforderung senden. Entfernen Sie Parameter, Header und Eingaben, die die API nicht benötigt.

    Generierte Eingaben

    Wenn Sie eine OpenAPI-Spezifikation importieren, erstellt das System alle erforderlichen Eingaben und fügt sie gegebenenfalls dem REST-Schritt-Formular hinzu. Zur Laufzeit sendet das System eine REST-Anforderung, die Eingabewerte enthält, die für die Aktion bereitgestellt werden. Wenn eine API beispielsweise einen Namensparameter erfordert, der in der Anforderung übergeben wird, erstellt das System einen Name Eingabe und fügt sie dem REST-Schritt hinzu. Wenn Sie dem Flow die Aktion hinzufügen, wird der Name zu einer Eingabe für die Aktion.

    Das System ordnet OpenAPI-Datentypen zu Workflow-Studio Datentypen. Wenn die OpenAPI-Spezifikation beispielsweise ein Anwenderobjekt erfordert, erstellt das System ein komplexes Datenobjekt als Eingabe. Weitere Informationen finden Sie unter Komplexe Daten .

    Größenbeschränkung für Spezifikation

    Standardmäßig kann das System OpenAPI-Spezifikationen bis zu 10 MB importieren. Um die Importgröße zu erhöhen, aktualisieren Sie glide.rest.openapi.max_request_sizeSystemeigenschaft. Der Höchstwert beträgt 100 MB.

    Spezifikationsmanagement

    Importieren Sie eine OpenAPI-Spezifikation, indem Sie im REST-Schritt Optionen auswählen. Weitere Informationen finden Sie unter REST-Schritt. Durch das Importieren einer OpenAPI-Spezifikation wird ein Datensatz in der OpenAPIs-Tabelle [sys_openapi] erstellt. Sie können Spezifikationsdatensätze direkt aus dieser Tabelle anzeigen oder löschen. Um eine Spezifikation zu aktualisieren, löschen Sie sie, und importieren Sie sie erneut.

    Design Überlegungen

    Erstellen Sie einen REST-Schritt aus einer OpenAPI-Spezifikation unter Berücksichtigung dieser Überlegungen.

    Entfernen Sie unnötige REST-Schrittparameter
    Beim Importieren einer OpenAPI-Spezifikation fügt das System dem REST-Schritt alle in der Spezifikation enthaltenen Parameter und Header hinzu. Überprüfen Sie die endgültigen REST-Schrittwerte, und entfernen Sie Parameter, die Sie in der Anforderung nicht senden möchten. Wenn die API beispielsweise Inhaltstypheader für JSON und XML akzeptiert, fügt das System beide Header dem REST-Schritt hinzu. Entfernen Sie je nach Inhaltstyp, den Sie in der Antwort erhalten möchten, einen der Header.
    Machen Sie Eingabebezeichnungen anwenderfreundlich
    Stellen Sie sicher, dass die für den REST-Schritt erforderlichen Eingabebezeichnungen klar und verständlich sind. Klare Bezeichnungen ermöglichen Flow-Designern, die erforderlichen Eingaben bei der Verwendung der Aktion in einem Flow leicht zu verstehen.
    Entfernen Sie Eingaben, die keine Flow Designer-Konfiguration erfordern
    Beim Importieren einer OpenAPI-Spezifikation fügt das System alle in der Spezifikation vorhandenen Eingaben dem Aktionseingabeabschnitt hinzu. Entfernen Sie alle Eingaben, für die kein Flow Designer konfiguriert werden muss. Wenn beispielsweise eine REST-Schrittvariable einen Wert aus einem anderen Schritt in der Aktion erhält, ist keine Aktionseingabe erforderlich.
    Vermeiden Sie das Ändern des API-Vorgangs
    Ändern des Werts von API-Vorgang Das Feld entfernt alle Werte, die von diesem Vorgang abhängig sind. Wenn Sie die OpenAPI-Spezifikationswerte im REST-Schritt-Formular konfigurieren und den Vorgang ändern, speichert das System Ihre Konfiguration nicht. Werte, die manuell von einem Anwender eingegeben werden, sind nicht betroffen.

    Einschränkungen

    Erstellen Sie einen REST-Schritt aus einer OpenAPI-Spezifikation mit diesen Einschränkungen.

    Medientypen des Anforderungstexts
    Der Anforderungstext unterstützt nur JSON- und XML-basierte Medientypen. Wenn der ausgewählte Vorgang aus der importierten OpenAPI-Spezifikation einen Anforderungstext mit einem anderen Medientyp enthält, fügt das System dem eine Datenpille vom Typ Zeichenfolge hinzu Anforderungstext Feld.
    OpenAPI 3,0-Komponenten

    OpenAPI 3,0 fügt Swagger 2,0 neue Komponenten hinzu, um eine API detaillierter zu beschreiben. Die OpenAPI-Unterstützung im REST-Schritt unterstützt einige, aber nicht alle dieser Komponenten. Der REST-Schritt unterstützt diese Komponenten derzeit nicht.

    • Schemaobjekt: Oneof-, anyOf-Eigenschaften
    • Unterscheiderobjekt
    • Informationsobjekt: TermsOfService, Kontakt, Lizenzfelder
    • Beispielobjekt
    • Objekt Verknüpfen
    • Rückrufobjekt
    • Sicherheitsschemaobjekt
    • Sicherheitsanforderungsobjekt
    • Tag-Objekt
    • Externes Dokumentationsobjekt
    • Serverobjekt
    • Spezifikationserweiterungen
    • Rekursive Referenzen

    Weitere Informationen zu diesen Komponenten finden Sie in der OpenAPI-Dokumentation. Siehe OpenAPI-Spezifikation .