新 HTTP 模块
http
新 HTTP 模块
FastGPT HTTP 模块介绍
特点
- 可重复添加
- 有外部输入
- 手动配置
- 触发执行
- 核中核模块
介绍
HTTP 模块会向对应的地址发送一个 POST/GET 请求，携带部分系统参数及自定义参数，并接收一个 JSON 响应值，字段也是自定义。
- 你还可以通过 JSON 传入自定义的请求头。
- POST 请求中，数据会被放置在
body中。 - GET 请求中，数据会被放置在
query中。 - 在出入参数中，你都可以通过 xxx.xxx 来代表嵌套的对象。
参数结构
系统参数说明
- appId: 应用的ID
- chatId: 当前对话的ID，测试模式下不存在。
- responseChatItemId: 当前对话中，响应的消息ID，测试模式下不存在。
- variables: 当前对话的全局变量。
- data: 自定义传递的参数。
嵌套对象使用
入参
假设我们设计了3个输入。
- user.name (string)
- user.age (number)
- type (string)
最终组成的对象为:
{
"user": {
"name": "",
"age": ""
},
"type": ""
}
出参
假设接口的输出结构为:
{
"message": "测试",
"data":{
"name": "name",
"age": 10
}
}
那么，自定出参的key可以设置为:
- message (string)
- data.name (string)
- data.age (number)
POST 示例
自定义入参
- user.name (string)
- user.age (number)
- type (string)
自定义出参
- message (string)
- data.name (string)
- data.age (number)
那么，这个模块发出的请求则是:
GET 示例
GET 中，不推荐使用嵌套参数，否则会出现奇怪的问题。此外，GET 请求中，FastGPT 会将参数扁平化，不会将自定义参单独抽到 data 中，同时全局变量也会扁平化，因此需要注意字段 key 是否冲突。
自定义入参
- name (string)
- age (number)
- type (string)
自定义出参
- message (string)
- name (string)
- age (number)
那么，这个模块发出的请求则是:
laf 对接 HTTP 示例
如果你不想额外部署服务，可以使用 Laf 来快速开发上线接口，即写即发，无需部署。
下面是在 Laf 编写的 POST 请求示例：
import cloud from '@lafjs/cloud'
const db = cloud.database()
type RequestType = {
appId: string;
data: {
appointment: string;
action: 'post' | 'delete' | 'put' | 'get'
}
}
export default async function (ctx: FunctionContext) {
try {
// 从 body 中获取参数
const { appId, data: { 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 模块你可以无限扩展，比如：
- 操作数据库
- 调用外部数据源
- 执行联网搜索
- 发送邮箱
- ….