Formatierung von HTTP-Connector-Ausgaben

Erfahren Sie, wie Sie die Ausgaben von HTTP-Konnektoren strukturieren können.

Übersicht

Der Connector-Funktionseditor in Tulip ermöglicht es Ihnen, die von Ihren Connector-Funktionen zurückgegebenen Daten so zu strukturieren, dass sie innerhalb Ihrer Anwendungen nützlich und verwendbar sind. In diesem Artikel werden wir die Grundlagen der Formatierung von Connector-Funktionen Outputs behandeln, indem wir Sie einführen in:

• Das Konzept eines Konnektors "Output"
• Verfügbare Werkzeuge zur Formatierung von Ausgaben
• Verschiedene gängige Ausgabeformate

Was sind Outputs?

Ausgaben werden verwendet, um die Rückgabeergebnisse der Konnektorfunktion zu definieren und zu strukturieren. Mit ihnen extrahieren Sie die Informationen, die für Ihre Anwendungen wichtig sind, aus einem größeren HTTP-Rückgabetext.

Wie man Ausgaben strukturiert

Suchen Sie den Abschnitt Ausgänge unten links im Editor für Connector-Funktionen.

Um mit dem Hinzufügen von Ausgaben zu beginnen, klicken Sie auf Add Function Outputs.

Es empfiehlt sich, den Ausgaben einen Namen zu geben, der identifizierbar ist. Diese Namen werden in Anwendungen als Variablen angezeigt, daher ist es wichtig, dass Sie sie unterscheiden können.

Um die Ergebnisse einer HTTP-Anfrage zu verstehen, ist es wichtig, zunächst die Form eines Objekts zu kennen, das in den Testergebnissen zurückgegeben wird. Das folgende Diagramm veranschaulicht, wie die Ergebnisse in Abschnitte von Objekten und Arrays aufgeteilt sind.

:::(Info) (HINWEIS) Wenn Sie noch nie mit JSON gearbeitet haben, sind Sie vielleicht nicht mit zwei wichtigen Datentypen vertraut: Objekte und Arrays. Arrays sind Listen von Werten desselben Typs. Zum Beispiel [1,2,3,5], oder [oak, elm, alder, hickory]. Werte in Arrays stehen in eckigen Klammern, [ ]. Objekte sind ein Datentyp zur Speicherung von Schlüssel:Wert-Paaren. Die Schlüssel:Wert-Paare innerhalb eines Objekts können mehrere verschiedene Typen haben, einschließlich Arrays und verschachtelte Objekte. Objekte werden mit geschweiften Klammern, { }. :::

Weitere Informationen zu Objekten und Arrays finden Sie unter Verstehen von Arrays und Objekten in Connector-Funktionsausgaben.

Punkt-Notation

Für HTTP-Konnektoren verwenden die Ausgaben ein Format namens Dot Notation. Mit der Punktnotation können Sie auf Werte innerhalb eines Objekts zugreifen. Die Punktnotation ist nützlich, um aus einem großen JSON-Antwortkörper nur das herauszuholen, was Sie brauchen, und sie gibt Ihnen mehr Flexibilität bei der Formatierung von HTTP-Konnektorfunktionen. Einfach ausgedrückt: Es ist ein strukturiertes Format, das auf ineinander verschachtelten Werten basiert.

Lassen Sie uns anhand eines Beispiels erläutern, wie die Punktnotation in Connector-Ausgaben verwendet wird.

Das folgende Beispielobjekt mit der Bezeichnung "employees" enthält ein Array von Objekten mit Details zu jedem Mitarbeiter. Wenn wir nur auf den Titel eines jeden Mitarbeiters zugreifen wollen, würden wir die Syntax: employees.title verwenden. Wir verwenden einen Dot, um auf die Werte zuzugreifen, die mit den Schlüsseln verbunden sind, an denen wir interessiert sind. Nehmen wir an, wir möchten nur das erste Ergebnis abrufen. Wir würden dies angeben, indem wir die Indexposition zwischen dem Namen des Hauptobjekts, "employees", und dem Wert, an dem wir interessiert sind, "title", hinzufügen. Die Syntax würde wie folgt aussehen: mitarbeiter.0.titel. Bei komplexeren Objekten müssen Sie möglicherweise tiefer in das Objekt eindringen, um die gewünschten Informationen zu erhalten.

Gehen wir mit einem anderen Beispiel noch einen Schritt weiter. In diesem Fall wollen wir eine Konnektorfunktion erstellen, die Informationen zu Artikeln in der Wissensdatenbank abruft. Unser Konnektor gibt das folgende JSON-Objekt mit dem Namen "data" zurück, das Daten über einen bestimmten Artikel enthält:

Wenn wir nur die ID, den Titel, die Version und die Angabe, ob der Artikel ausgeblendet ist oder nicht, abrufen möchten. Dann müssten wir dies mit Hilfe von Outputs spezifizieren. Lassen Sie uns demonstrieren, wie die Punktnotation im Abschnitt outputs des Editors aussieht:

Um Ergebnisse wie "id" und "title" zu erhalten, müssen wir angeben, wo sich diese Ergebnisse innerhalb des JSON befinden. Der Körper der Ausgabe ist "data", was dem ersten Dropdown im Abschnitt " Testergebnisse" entspricht. Jedes Ergebnis innerhalb des Dropdown-Menüs "data" ist in diesem Objekt verschachtelt. Im Abschnitt " Outputs" bedeutet ein Punkt, dass Sie eine Ebene tiefer in das Objekt "data" gehen.

:::(Info) (HINWEIS) Es spielt keine Rolle, ob der Punkt im Hauptteil oder vor einzelnen Eigenschaften platziert wird, solange jede Ebene des JSON durch einen Punkt getrennt ist:::

Wenn wir im Abschnitt Testergebnisse auf die Registerkarte Ausgaben klicken, filtern wir den Rest der Daten heraus, damit wir nur die Informationen sehen, die uns interessieren.

Eine weitere Möglichkeit, Ihre Ausgaben zu schreiben, ist eine einzelne Zeile. Dies zeigt den vollständigen Pfad in einer Abfrage an.

Sie können auch auf eine Datenzeile klicken, um sie als neue Ausgabe hinzuzufügen, um den Ausgabepfad einfach zu schreiben.

Weitere Informationen zur Verwendung der Punktnotation finden Sie in dieser Ressource: Wie man die Punktnotation verwendet, um auf Informationen in einem JSON-Objekt zuzugreifen.

Ausgabeergebnisse

Es gibt mehrere Möglichkeiten, Ausgaben zu strukturieren, aber wie Sie dies tun, hängt ganz davon ab, was Sie mit den Daten in Ihren Anwendungen tun möchten. Bevor Sie mit der Strukturierung von Ausgaben beginnen, sollten Sie sich Gedanken über Ihr Endziel machen. Möchten Sie mehrere Datentypen in einzelnen Variablen anzeigen? Oder haben Sie dieselben Datentypen in einem Array, das Sie einfach nach relevanten Informationen durchsuchen wollen?

Die folgenden Beispiele basieren alle auf derselben Konnektorfunktion, und der Hauptteil der Testergebnisse ist in jedem Fall derselbe. Die Ausgaben unterscheiden sich jedoch aufgrund ihrer Struktur.

Das folgende Beispiel zeigt, wie der Konnektor für den JSON-Pfad data.hits.slug ausgibt. So wie diese Ausgabe strukturiert ist, gibt der Konnektor ein großes Array mit allen URL-Slugs für Knowledge Base-Artikel zurück. In unseren Anwendungen wird diese Rückgabe des Konnektors in einer Array-Variablen zugänglich sein.

Wir können die Ausgaben als Liste von Objekten strukturieren und einzelne Datentypen aus den Ergebnissen ziehen, um mehrere Datenobjekte zu erstellen, die in Anwendungen einzeln sichtbar sein können.

Listen von Objekten sind Objekte, die mehrere verschachtelte Datentypen enthalten. Verwenden Sie Listen von Objekten, indem Sie auf den Ausgabetyp klicken und den Schalter Liste in der rechten Ecke umschalten.

Wenn Sie eine Liste von Objekten haben, können Sie verschiedene Datentypen problemlos als einzelne Daten in Ihren Anwendungen verwenden.

Kehren wir zum obigen Beispiel zurück und machen wir unseren Ausgabepfad data.hits.slug zu einer Liste. In den Ergebnissen unten können Sie sehen, dass Tulip diesen Konnektor als Array von Slugs strukturiert, wobei jede Indexposition neben jedem Wert aufgeführt ist.

Mit diesem Verständnis der Ausgaben können Sie nun die Ausgaben Ihren eigenen Konnektor-Funktionen zuordnen und die von Ihren Konnektoren zurückgegebenen Ergebnisse optimieren!

Weitere Lektüre

• Verwendung von HTTP-Konnektoren in Anwendungen
• Interaktive Listen von Tabellensätzen oder Konnektorausgaben in Apps anzeigen

Haben Sie gefunden, wonach Sie gesucht haben?

Sie können auch zu community.tulip.co gehen, um Ihre Frage zu stellen oder zu sehen, ob andere mit einer ähnlichen Frage konfrontiert wurden!