FastGPT/docSite/content/zh-cn/docs/workflow/modules/http.md

title, description, icon, draft, toc, weight

title	description	icon	draft	toc	weight
HTTP 模块	FastGPT HTTP 模块介绍	http	false	true	355

特点

• 可重复添加
• 手动配置
• 触发执行
• 核中核模块

介绍

HTTP 模块会向对应的地址发送一个 HTTP 请求，实际操作与 Postman 和 ApiFox 这类直流工具使用差不多。

• Params 为路径请求参数，GET请求中用的居多。
• Body 为请求体，POST/PUT请求中用的居多。
• Headers 为请求头，用于传递一些特殊的信息。
• 自定义变量中可以接收前方节点的输出作为变量
• 3 种数据中均可以通过 {{}} 来引用变量。
• url 也可以通过 {{}} 来引用变量。
• 变量来自于全局变量、系统变量、前方节点输出

参数结构

系统变量说明

你可以将鼠标放置在请求参数旁边的问号中，里面会提示你可用的变量。

• appId: 应用的ID
• chatId: 当前对话的ID，测试模式下不存在。
• responseChatItemId: 当前对话中，响应的消息ID，测试模式下不存在。
• variables: 当前对话的全局变量。
• cTime: 当前时间。
• histories: 历史记录（默认最多取10条，无法修改长度）

Params, Headers

不多描述，使用方法和Postman, ApiFox 基本一致。

可通过 {{key}} 来引入变量。例如：

key	value
appId	{{appId}}
Authorization	Bearer {{token}}

Body

只有特定请求类型下会生效。

可以写一个自定义的 Json，并通过 {{key}} 来引入变量。例如：

{{< tabs tabTotal="3" >}} {{< tab tabName="假设有一组变量" >}} {{< markdownify >}}

{
  "string": "字符串",
  "number": 123,
  "boolean": true,
  "array": [1, 2, 3],
  "obj": {
    "name": "FastGPT",
    "url": "https://tryfastgpt.ai"
  }
}

{{< /markdownify >}} {{< /tab >}} {{< tab tabName="Http 模块中的Body声明" >}} {{< markdownify >}}

注意，在 Body 中，你如果引用字符串，则需要加上""，例如："{{string}}"。

{
  "string": "{{string}}",
  "token": "Bearer {{string}}",
  "number": {{number}},
  "boolean": {{boolean}},
  "array": [{{number}}, "{{string}}"],
  "array2": {{array}},
  "object": {{obj}}
}

{{< /markdownify >}} {{< /tab >}} {{< tab tabName="最终得到的解析" >}} {{< markdownify >}}

{
  "string": "字符串",
  "token": "Bearer 字符串",
  "number": 123,
  "boolean": true,
  "array": [123, "字符串"],
  "array2": [1, 2, 3],
  "object": {
    "name": "FastGPT",
    "url": "https://tryfastgpt.ai"
  }
}

{{< /markdownify >}} {{< /tab >}} {{< /tabs >}}

如何获取返回值

从图中可以看出，FastGPT可以添加多个返回值，这个返回值并不代表接口的返回值，而是代表如何解析接口返回值，可以通过 JSON path 的语法，来提取接口响应的值。

语法可以参考: https://github.com/JSONPath-Plus/JSONPath?tab=readme-ov-file

{{< tabs tabTotal="2" >}} {{< tab tabName="接口响应示例" >}} {{< markdownify >}}

{
  "message": "测试",
  "data":{
      "user": {
        "name": "xxx",
        "age": 12
      },
      "list": [
        {
          "name": "xxx",
          "age": 50
        },
        [{ "test": 22 }]
      ],
      "psw": "xxx"
  }
}

{{< /markdownify >}} {{< /tab >}} {{< tab tabName="提取示例" >}} {{< markdownify >}}

{
  "$.message": "测试",
  "$.data.user": { "name": "xxx", "age": 12 },
  "$.data.user.name": "xxx",
  "$.data.user.age": 12,
  "$.data.list": [ { "name": "xxx", "age": 50 }, [{ "test": 22 }] ],
  "$.data.list[0]": { "name": "xxx", "age": 50 },
  "$.data.list[0].name": "xxx",
  "$.data.list[0].age": 50,
  "$.data.list[1]": [ { "test": 22 } ],
  "$.data.list[1][0]": { "test": 22 },
  "$.data.list[1][0].test": 22,
  "$.data.psw": "xxx"
}

{{< /markdownify >}} {{< /tab >}} {{< /tabs >}}

你可以配置对应的key来从FastGPT 转化后的格式获取需要的值，该规则遵守 JS 的对象取值规则。例如：

1. 获取message的内容，那么你可以配置message的key为message，这样就可以获取到message的内容。
2. 获取user的name，则key可以为：data.user.name。
3. 获取list中第二个元素，则key可以为：data.list[1]，然后输出类型选择字符串，则获自动获取到[ { "test": 22 } ]的json字符串。

自动格式化输出

FastGPT v4.6.8 后，加入了出参格式化功能，主要以json格式化成字符串为主。如果你的输出类型选择了字符串，则会将HTTP对应key的值，转成json字符串进行输出。因此，未来你可以直接从HTTP接口输出内容至文本加工中，然后拼接适当的提示词，最终输入给AI对话。

{{% alert context="warning" %}} HTTP模块非常强大，你可以对接一些公开的API，来提高编排的功能。

如果你不想额外部署服务，可以使用 Laf 来快速开发上线接口，即写即发，无需部署。 {{% /alert %}}

laf 对接 HTTP 示例

下面是在 Laf 编写的 POST 请求示例：

import cloud from '@lafjs/cloud'
const db = cloud.database()

type RequestType = {
  appId: string;
  appointment: string;
  action: 'post' | 'delete' | 'put' | 'get'
}

export default async function (ctx: FunctionContext) {
  try {
    // 从 body 中获取参数
    const { appId, appointment, action } = ctx.body as RequestType

    const parseBody = JSON.parse(appointment)
    if (action === 'get') {
      return await getRecord(parseBody)
    }
    if (action === 'post') {
      return await createRecord(parseBody)
    }
    if (action === 'put') {
      return await putRecord(parseBody)
    }
    if (action === 'delete') {
      return await removeRecord(parseBody)
    }


    return {
      response: "异常"
    }
  } catch (err) {
    return {
      response: "异常"
    }
  }
}

作用

通过 HTTP 模块你可以无限扩展，比如：

• 操作数据库
• 调用外部数据源
• 执行联网搜索
• 发送邮箱
• ....

相关示例

• 谷歌搜索
• 发送飞书webhook
• 实验室预约（操作数据库）