跳轉到內容

Http Request(HTTP 請求)

節點概述

節點英文名: Http Request
節點中文名稱: Http 請求
支援場景: Chatflow Agent(支援), Workflow Agent(支援)

功能說明

Http Request 節點用於訪問 Http 的介面,獲取資料。它提供了強大的 HTTP 請求能力,支援各種 HTTP 方法和請求配置,能夠與外部 API 進行互動,獲取和處理資料。

節點展示內容

HTTP 請求節點在畫布上的展示:節點圖示與名稱,左右連線點,頂部懸浮試執行與更多按鈕

1. 基本資訊展示

  • 圖示: 節點專用圖示
  • 名稱: 節點名稱
  • 註釋: 使用者新增的說明文字

2. 操作按鈕

  • 更多按鈕: 點選後展示右鍵選單內容
  • 執行按鈕: 點選進入試執行介面

節點編輯區域

HTTP 請求編輯面板:API(請求方法 + URL,支援插入變數與匯入 cURL)、HEADERS/PARAMS 鍵值對、BODY 型別 (none/form-data/x-www-form-urlencoded/json/raw-text),輸出變數 body/status_code/headers/files

1. API 配置

  • 請求方法: 下拉選擇 HTTP 方法(GET、POST、PUT、DELETE、PATCH 等)
  • 請求 URL: 設定目標 API 的 URL 地址,輸入 / 可插入變數
  • 匯入 cURL: 支援貼上 cURL 命令一鍵生成請求配置

2. HEADERS / PARAMS

  • HEADERS: 以鍵值對方式配置 HTTP 請求頭(需要鑑權的介面在此配置,如 Authorization: Bearer <token>
  • PARAMS: 以鍵值對方式配置 URL 查詢引數

3. BODY 配置

  • 型別選擇: none / form-data / x-www-form-urlencoded / json / raw-text
  • 請求體: 根據所選型別設定請求體內容

4. 輸出變數

  • body (string): 響應內容
  • status_code (number): 響應狀態碼
  • headers (object): 響應頭列表 JSON
  • files (array[file]): 檔案列表

5. 下一步配置

  • 支援新增下一個節點

執行邏輯

Http Request 節點的執行邏輯由後端實現,確保 HTTP 請求的正確執行和響應處理。

右鍵操作

右鍵選單包含以下選項:

  1. 更改節點: 修改節點型別
  2. 複製: 複製節點
  3. 複製: 複製節點內容
  4. 刪除: 刪除節點
  5. 幫助連結: 跳轉到幫助文件
  6. 執行節點: 測試運行當前節點

測試執行

  • 支援狀態: 支援測試執行
  • 更改節點: 支援更改節點型別
  • 複製功能: 支援複製、剪貼、刪除操作

HTTP 方法支援

1. GET 請求

  • 用途: 獲取資料
  • 特點: 無請求體,引數通過 URL 傳遞
  • 示例: 獲取使用者資訊、查詢資料

2. POST 請求

  • 用途: 建立資料
  • 特點: 有請求體,用於提交資料
  • 示例: 建立使用者、提交表單

3. PUT 請求

  • 用途: 更新資料
  • 特點: 完整更新資源
  • 示例: 更新使用者資訊、修改配置

4. DELETE 請求

  • 用途: 刪除資料
  • 特點: 刪除指定資源
  • 示例: 刪除使用者、移除資料

5. PATCH 請求

  • 用途: 部分更新
  • 特點: 只更新部分欄位
  • 示例: 更新使用者狀態、修改部分資訊

使用場景

1. API 整合

  • 第三方服務: 整合第三方 API 服務
  • 資料獲取: 從外部系統獲取資料
  • 服務呼叫: 呼叫微服務介面
  • 資料同步: 同步外部系統資料

2. 資料交換

  • 資料推送: 向外部系統推送資料
  • 資料拉取: 從外部系統拉取資料
  • 資料轉換: 轉換資料格式
  • 資料驗證: 驗證資料有效性

3. 業務流程

  • 工作流整合: 整合外部工作流
  • 審批流程: 呼叫審批系統
  • 通知服務: 傳送通知訊息
  • 日誌記錄: 記錄操作日誌

4. 系統整合

  • 單點登入: 整合 SSO 系統
  • 使用者管理: 整合使用者管理系統
  • 許可權控制: 整合許可權管理系統
  • 監控告警: 整合監控系統

鑑權說明

節點沒有獨立的認證配置區,需要鑑權的介面通過 HEADERS / PARAMS 配置:

  • Basic Auth: HEADERS 中新增 Authorization: Basic base64(username:password)
  • Bearer Token: HEADERS 中新增 Authorization: Bearer <token>
  • API Key: 按介面要求放入 HEADERS 或 PARAMS 中傳遞

最佳實踐

1. 請求設計

  • URL 設計: 使用 RESTful 風格的 URL
  • 引數傳遞: 合理使用 URL 引數和請求體
  • 狀態碼: 正確使用 HTTP 狀態碼
  • 錯誤處理: 提供清晰的錯誤資訊

2. 安全考慮

  • HTTPS: 使用 HTTPS 協議
  • 認證: 使用安全的認證方式
  • 引數驗證: 驗證輸入引數
  • 敏感資訊: 保護敏感資訊

3. 錯誤處理

  • 狀態碼判斷: 用 status_code 輸出變數在下游(如 IF Else)判斷請求是否成功
  • 降級處理: 為失敗分支設計兜底邏輯

配置步驟

1. 基礎配置

  1. 選擇 HTTP 方法
  2. 設定請求 URL
  3. 配置請求頭

2. 請求體配置

  1. 選擇內容型別
  2. 設定請求體內容
  3. 配置引數

3. 測試驗證

  1. 使用試執行功能測試
  2. 檢查響應資料
  3. 驗證錯誤處理

常見問題

Q: 如何處理認證失敗?

A: 檢查 HEADERS 中的認證頭格式與憑證是否正確(如 Bearer Token 是否有效、是否過期)。

Q: 如何除錯 HTTP 請求?

A: 使用試執行功能,檢視請求和響應詳情,檢查狀態碼和錯誤資訊。

Q: BODY 支援哪些型別?

A: none、form-data、x-www-form-urlencoded、json、raw-text 五種。

注意事項

  1. URL 編碼: 確保 URL 引數正確編碼
  2. 請求頭: 設定正確的 Content-Type
  3. 認證資訊: 保護認證資訊的安全,避免在提示詞或輸出中洩露
  4. 錯誤處理: 用 status_code 判斷結果,為失敗情況設計兜底分支