レスポンス

レスポンスブロックはワークフローの最終ステップであり、APIコールに対して構造化されたレスポンスをフォーマットして送信します。これはワークフロー全体の「return」ステートメントのようなもので、結果をパッケージ化して返送します。

概要

レスポンスブロックでは以下のことが可能です：

動作の仕組み

レスポンスブロックはワークフローの実行を完了させます：

1. データの収集 - 前のブロックからの変数と出力を収集する
2. レスポンスのフォーマット - 設定に従ってデータを構造化する
3. HTTP詳細の設定 - ステータスコードとヘッダーを適用する
4. レスポンスの送信 - フォーマットされたレスポンスをAPI呼び出し元に返す

レスポンスブロックが必要な場合

• APIエンドポイント：ワークフローがAPI経由で呼び出される場合、レスポンスブロックは返すデータをフォーマットします
• ウェブフック：確認またはデータを呼び出しシステムに返します
• テスト：ワークフローをテストする際にフォーマットされた結果を確認できます

レスポンスを構築する2つの方法

ビルダーモード（推奨）

レスポンス構造を構築するためのビジュアルインターフェース：

• フィールドのドラッグ＆ドロップ
• ワークフロー変数の簡単な参照
• レスポンス構造のビジュアルプレビュー

エディターモード（上級者向け）

JSONを直接記述：

• レスポンス形式の完全な制御
• 複雑なネスト構造のサポート
• 動的な値には <variable.name> 構文を使用

設定オプション

レスポンスデータ

レスポンスデータは、APIの呼び出し元に送り返される主要なコンテンツです。JSONとして形式化され、以下を含めることができます：

• 静的な値
• <variable.name> 構文を使用したワークフロー変数への動的な参照
• ネストされたオブジェクトと配列
• 任意の有効なJSON構造

ステータスコード

レスポンスのHTTPステータスコードを設定します。一般的なステータスコードには以下があります：

レスポンスヘッダー

レスポンスに含める追加のHTTPヘッダーを設定します。

ヘッダーはキーと値のペアとして設定されます：

使用例

APIエンドポイントのレスポンス

Webhook確認

エラーレスポンスの処理

入力と出力

変数の参照

<variable.name> 構文を使用して、ワークフロー変数を応答に動的に挿入します：

{
  "user": {
    "id": "<variable.userId>",
    "name": "<variable.userName>",
    "email": "<variable.userEmail>"
  },
  "query": "<variable.searchQuery>",
  "results": "<variable.searchResults>",
  "totalFound": "<variable.resultCount>",
  "processingTime": "<variable.executionTime>ms"
}

ベストプラクティス

• 意味のあるステータスコードを使用する: ワークフローの結果を正確に反映する適切なHTTPステータスコードを選択してください
• 一貫した応答構造を維持する: より良い開発者体験のために、すべてのAPIエンドポイントで一貫したJSON構造を維持してください
• 関連するメタデータを含める: デバッグとモニタリングに役立つタイムスタンプとバージョン情報を追加してください
• エラーを適切に処理する: ワークフローで条件付きロジックを使用して、説明的なメッセージを含む適切なエラー応答を設定してください
• 変数参照を検証する: 応答ブロックが実行される前に、参照されるすべての変数が存在し、予想されるデータ型を含んでいることを確認してください