小程序开放平台

文档中心
快速入门
开发准备
本地开发
本地开发函数服务
小红书云CLI工具
函数配置文件
部署发布
功能服务
常见问题

函数配置文件

开发指南
>
本地开发
>
函数配置文件
>
更新时间:2026-01-16 11:44:58

agent-cloudbase-functions.json
是云函数项目的核心配置文件,用于定义云函数的组织结构、路由映射和部署信息。

文件位置

配置文件应位于项目根目录,与

package.json
同级。

your-project/
├── agent-cloudbase-functions.json  ← 配置文件位置
├── package.json
└── src/
    └── ...

配置结构

基本结构

{
  "functionsRoot": "./src",
  "functions": [
    {
      "name": "函数名称",
      "directory": "./相对路径",
      "source": "入口文件名",
      "triggerPath": "/路由路径"
    }
  ]
}

字段说明

顶层字段

字段
类型
必填
说明
functionsRoot
string
✅ 是函数代码的根目录,相对于配置文件所在目录。通常为
"./src"
functions
FunctionConfig[]
✅ 是函数配置数组,至少需要配置一个函数

FunctionConfig 字段

字段
类型
必填
说明
name
string
✅ 是函数名称,必须与代码中导出的函数名一致
directory
string
✅ 是函数代码所在的目录,相对于
functionsRoot
。使用
"./"
表示根目录
source
string
✅ 是入口文件名,通常是
"index.js"
triggerPath
string
✅ 是HTTP 触发路径,必须以
/
开头。例如:
"/"
"/user/profile"

注意

triggerPath
必须唯一,不能有重复的路由路径。

配置示例

单函数配置

{
  "functionsRoot": "./src",
  "functions": [
    {
      "name": "main",
      "directory": "./",
      "source": "index.js",
      "triggerPath": "/"
    }
  ]
}

多函数配置

{
  "functionsRoot": "./src",
  "functions": [
    {
      "name": "userProfile",
      "directory": "./user",
      "source": "index.js",
      "triggerPath": "/user/profile"
    },
    {
      "name": "booksList",
      "directory": "./books",
      "source": "index.js",
      "triggerPath": "/books/list"
    }
  ]
}

项目依赖配置

package.json
中需要配置项目信息和依赖:

{
  "version": "1.0.0",
  "description": "智能体模板",
  "scripts": {
    "dev": "rcb-ff"
  },
  "dependencies": {
    "@vectorx/functions-framework": "latest"
  }
}

package.json 字段说明

字段
类型
必填
说明
version
string
❌ 否项目版本号,遵循 semver 规范(如
"1.0.0"
description
string
❌ 否项目描述信息
scripts
object
❌ 否脚本命令,
"dev": "rcb-ff"
用于启动本地开发服务器
dependencies
object
✅ 是项目依赖,必须包含
@vectorx/functions-framework

函数代码要求

函数必须按照配置的

name
字段导出,函数签名:
async (req, res) => {}

javascript
// src/index.js(对应 name: "main")
exports.main = async (req, res) => {
  res.json({ message: "Hello World" });
};

// src/user/index.js(对应 name: "userProfile")
exports.userProfile = async (req, res) => {
  res.json({ user: { name: "Alice" } });
};

路径说明

  • functionsRoot
    :相对于配置文件所在目录
  • directory
    :相对于
    functionsRoot
  • triggerPath
    :必须以
    /
    开头,不能重复

示例:

functionsRoot: "./src"
+
directory: "./user"
+
source: "index.js"
→ 实际路径为
src/user/index.js

注意事项

  1. 函数名称必须匹配:配置中的
    name
    必须与代码中导出的函数名完全一致
  2. 路径不能重复
    triggerPath
    在整个配置中必须唯一
  3. 文件必须存在:配置的入口文件路径必须真实存在
  4. 依赖安装:确保在
    package.json
    中正确安装
    @vectorx/functions-framework
    依赖