Antwort
Der Antwort-Block ist der letzte Schritt in deinem Workflow, der eine strukturierte Antwort formatiert und an API-Aufrufe zurücksendet. Er funktioniert wie eine "return"-Anweisung für deinen gesamten Workflow – er verpackt Ergebnisse und sendet sie zurück.
Antwort-Blöcke sind terminale Blöcke - sie beenden die Workflow-Ausführung und können nicht mit anderen Blöcken verbunden werden.
Überblick
Der Antwort-Block ermöglicht dir:
API-Antworten formatieren: Strukturierung von Workflow-Ergebnissen in korrekte HTTP-Antworten
Statuscodes festlegen: Konfiguration passender HTTP-Statuscodes basierend auf Workflow-Ergebnissen
Header kontrollieren: Hinzufügen benutzerdefinierter Header für API-Antworten und Webhooks
Daten transformieren: Umwandlung von Workflow-Variablen in client-freundliche Antwortformate
Wie es funktioniert
Der Antwort-Block schließt die Workflow-Ausführung ab:
- Daten sammeln - Sammelt Variablen und Ausgaben von vorherigen Blöcken
- Antwort formatieren - Strukturiert Daten gemäß deiner Konfiguration
- HTTP-Details festlegen - Wendet Statuscodes und Header an
- Antwort senden - Gibt die formatierte Antwort an den API-Aufrufer zurück
Wann du Antwort-Blöcke benötigst
- API-Endpunkte: Wenn dein Workflow über eine API aufgerufen wird, formatieren Antwort-Blöcke die Rückgabedaten
- Webhooks: Rückgabe von Bestätigungen oder Daten an das aufrufende System
- Testen: Anzeige formatierter Ergebnisse beim Testen deines Workflows
Zwei Möglichkeiten zum Erstellen von Antworten
Builder-Modus (Empfohlen)
Visuelle Oberfläche zum Erstellen der Antwortstruktur:
- Felder per Drag-and-Drop einfügen
- Einfache Referenzierung von Workflow-Variablen
- Visuelle Vorschau der Antwortstruktur
Editor-Modus (Fortgeschritten)
JSON direkt schreiben:
- Volle Kontrolle über das Antwortformat
- Unterstützung für komplexe verschachtelte Strukturen
- Verwendung der
<variable.name>Syntax für dynamische Werte
Konfigurationsoptionen
Antwortdaten
Die Antwortdaten sind der Hauptinhalt, der an den API-Aufrufer zurückgesendet wird. Diese sollten als JSON formatiert sein und können Folgendes enthalten:
- Statische Werte
- Dynamische Verweise auf Workflow-Variablen mit der
<variable.name>Syntax - Verschachtelte Objekte und Arrays
- Jede gültige JSON-Struktur
Statuscode
Legen Sie den HTTP-Statuscode für die Antwort fest. Häufige Statuscodes sind:
- 200: OK - Standard-Erfolgsantwort
- 201: Erstellt - Ressource erfolgreich erstellt
- 204: Kein Inhalt - Erfolg ohne Antworttext
- 400: Ungültige Anfrage - Ungültige Anfrageparameter
- 401: Nicht autorisiert - Authentifizierung erforderlich
- 404: Nicht gefunden - Ressource existiert nicht
- 422: Nicht verarbeitbare Entität - Validierungsfehler
- 500: Interner Serverfehler - Serverseitiger Fehler
- 502: Bad Gateway - Fehler eines externen Dienstes
- 503: Dienst nicht verfügbar - Dienst vorübergehend nicht erreichbar
Der Standard-Statuscode ist 200, wenn nicht anders angegeben.
Antwort-Header
Konfigurieren Sie zusätzliche HTTP-Header, die in die Antwort aufgenommen werden sollen.
Header werden als Schlüssel-Wert-Paare konfiguriert:
| Schlüssel | Wert |
|---|---|
| Content-Type | application/json |
| Cache-Control | no-cache |
| X-API-Version | 1.0 |
Beispielanwendungsfälle
API-Endpunkt-Antwort
Szenario: Strukturierte Daten von einer Such-API zurückgeben
- Workflow verarbeitet Suchanfrage und ruft Ergebnisse ab
- Funktionsblock formatiert und paginiert Ergebnisse
- Antwortblock gibt JSON mit Daten, Paginierung und Metadaten zurück
- Client erhält strukturierte Antwort mit Status 200
Webhook-Bestätigung
Szenario: Bestätigung des Webhook-Empfangs und der Verarbeitung
- Webhook-Trigger empfängt Daten vom externen System
- Workflow verarbeitet die eingehenden Daten
- Antwortblock gibt Bestätigung mit Verarbeitungsstatus zurück
- Externes System erhält Bestätigung
Fehlerantwort-Behandlung
Szenario: Angemessene Fehlerantworten zurückgeben
- Bedingungsblock erkennt Validierungsfehler oder Systemfehler
- Router leitet zum Fehlerbehandlungspfad weiter
- Antwortblock gibt Status 400/500 mit Fehlerdetails zurück
- Client erhält strukturierte Fehlerinformationen
Eingaben und Ausgaben
Antwortdaten: JSON-Struktur für den Antworttext
Statuscode: HTTP-Statuscode (Standard: 200)
Header: Benutzerdefinierte HTTP-Header als Schlüssel-Wert-Paare
Modus: Builder- oder Editor-Modus für die Antworterstellung
response.data: Der strukturierte Antworttext
response.status: Gesendeter HTTP-Statuscode
response.headers: In der Antwort enthaltene Header
response.success: Boolescher Wert, der erfolgreichen Abschluss anzeigt
HTTP-Antwort: Vollständige Antwort an den API-Aufrufer
Workflow-Beendigung: Beendet die Workflow-Ausführung
Zugriff: Antwortblöcke sind terminal - keine nachfolgenden Blöcke
Variablenreferenzen
Verwenden Sie die <variable.name> Syntax, um Workflow-Variablen dynamisch in Ihre Antwort einzufügen:
{
"user": {
"id": "<variable.userId>",
"name": "<variable.userName>",
"email": "<variable.userEmail>"
},
"query": "<variable.searchQuery>",
"results": "<variable.searchResults>",
"totalFound": "<variable.resultCount>",
"processingTime": "<variable.executionTime>ms"
}Variablennamen sind Groß- und Kleinschreibung sensitiv und müssen exakt mit den in Ihrem Workflow verfügbaren Variablen übereinstimmen.
Best Practices
- Verwenden Sie aussagekräftige Statuscodes: Wählen Sie passende HTTP-Statuscodes, die das Ergebnis des Workflows genau widerspiegeln
- Strukturieren Sie Ihre Antworten einheitlich: Behalten Sie eine konsistente JSON-Struktur über alle API-Endpunkte hinweg für eine bessere Entwicklererfahrung bei
- Fügen Sie relevante Metadaten hinzu: Ergänzen Sie Zeitstempel und Versionsinformationen, um bei der Fehlersuche und Überwachung zu helfen
- Behandeln Sie Fehler elegant: Verwenden Sie bedingte Logik in Ihrem Workflow, um angemessene Fehlerantworten mit aussagekräftigen Meldungen zu setzen
- Validieren Sie Variablenreferenzen: Stellen Sie sicher, dass alle referenzierten Variablen existieren und die erwarteten Datentypen enthalten, bevor der Response-Block ausgeführt wird