快速开始
本文介绍如何使用 CloudBase CLI 快速管理集成配置。
什么是集成
集成是云开发提供的一种能力,允许您将第三方服务或自定义业务逻辑与云函数绑定,实现更灵活的业务场景。
快速体验
1. 安装并登录 CLI
npm install -g @cloudbase/cli
tcb login
2. 查询可用集成类型(可选)
如果您不知道有哪些集成类型可用,可以先查询:
# 查询所有可用的集成类型
tcb integration types
# 按授权类型 Code 筛选
tcb integration types --auth-type-code weixinpaydc
3. 初始化集成配置(可选)
如果您希望通过配置文件管理集成,可以先初始化集成配置模板:
# 交互式初始化集成配置
tcb config init integration <keyId>
# 指定集成类型
tcb config init integration <keyId> --type weixinpaydc
初始化后会生成 cloudbaserc.json 配置文件,您可以编辑该文件填入具体配置值,然后使用 tcb config update integration 推送到云端。
提示:通过配置文件管理集成可以实现版本控制、团队协作等好处。如果您只需要快速体验,可以直接跳到步骤 4 使用命令创建集成。
4. 创建集成
# 从配置文件创建集成(交互式确认是否批量创建)
tcb integration create
# 跳过确认,批量创建配置文件中的所有集成
tcb integration create --yes
5. 查看集成列表
# 查看当前环境的所有集成
tcb integration list
# 以 JSON 格式输出
tcb integration list --json
6. 绑定云函数
提示
如果您需要集成配套的云函数模板代码(含微信支付、微信公众号等场景的云函数源码 + 前端示例 + 最小可运行 demo),可以前往 示例工程与参考资料 直接 clone 改造,再配合下面的命令绑定到您的环境中。
# 将集成绑定到云函数
tcb integration bind-resource --key-id key-xxx --function my-function
7. 查看集成详情
# 通过 Key ID 查询
tcb integration get key-xxx
8. 更新集成
通过配置文件更新集成配置:
# 编辑 cloudbaserc.json 中的 integrations 配置
# 然后执行以下命令推送到云端
tcb config update integration key-xxx
提示:更多配置更新方式请参考 配置文件 - 推送配置。
9. 删除集成
# 删除指定集成
tcb integration delete key-xxx
常用命令
| 命令 | 说明 |
|---|---|
tcb integration types | 查询可用集成类型 |
tcb integration create | 创建集成 |
tcb integration list | 查询集成列表 |
tcb integration get | 查询集成详情 |
tcb config update integration | 更新集成配置 |
tcb integration bind-resource | 绑定云函数 |
tcb integration delete | 删除集成 |