跳转到内容

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 判断结果,为失败情况设计兜底分支