跳到主要内容

新建数据源

根据数据源目的及存储方式的不同, 数据源可分为下面两类:

  • 自建数据源: 使用云开发数据库存储数据, 提供预置的数据源操作方法, 同时也可以编写云函数来实现自定义的业务需求
  • 外部数据源: 用于将第三方已有的 HTTP 接口集成到低码平台, 提供可视化界面录入 HTTP 接口, 也可以通过编写云函数方式更灵活的接入第三方 HTTP 接口

两种类型数据源的创建过程略有区别, 下边会分别介绍说明.

新建自建数据源#

填写基础信息#

提示

数据源标识为数据源的唯一标识, 在微搭应用编辑器及应用的低代码编辑器中均需要借助这个标识来使用数据源. 故这个标识应当遵循一般代码变量命名规则, 命名时应当具有一定的可读性.
平台会自动为用户输入的内容增加一个随机唯一的后缀, 以保证数据源标识的唯一性.

创建方式#

创建方式分为两种:

  • 默认方式: 使用默认行为创建数据源, 为数据源添加默认的字段及内置方法
  • Excel上传: 在 默认方式 之上, 通过上传Excel文件, 平台对文件进行解析完成数据源结构和数据值的初始化。 注意, 表格的表头会自动添加至数据源字段中, 故表头名应符合数据源字段命名要求: 以英文开头且只能包含英文、数字及下划线.

填写字段配置#

数据源模型数据源会预置六个字段: _id(数据标识)、createdAt(创建时间)、updatedAt(更新时间)、owner(所有人)、createBy(创建人)、updateBy(修改人).
预置字段不可编辑不可删除. 可点击 添加字段 按钮来添加自定义字段

添加自定义方法(可选)#

数据源的方法提供了访问和使用数据源的功能入口, 前端应用实际是通过调用数据源方法来使用数据源的.

自建数据源提供了六个内置方法, 覆盖了常见的使用场景: create(新增)、update(更新)、getItem(查看单条)、delete(删除)、getList(查看多条)、getRecords(查询列表).
注意这些内置方法不能禁用也无法删除.

若自建数据源的内置方法不满足需求, 可添加自定义方法, 具体可参考 添加数据源自定义方法

新建外部数据源#

填写基础信息#

提示

如新建自建数据源一样, 数据源标识为数据源的唯一标识, 在微搭应用编辑器及应用的低代码编辑器中均需要借助这个标识来使用数据源. 故这个标识应当遵循一般代码变量命名规则, 命名时应当具有一定的可读性.
平台会自动为用户输入的内容增加一个随机唯一的后缀, 以保证数据源标识的唯一性.

数据来源#

分为两种:

  • 模版创建: 使用预置模版来创建外部数据源. 目前有以下几个模版:
    • 空白模版: 不预置任何内容, 需要用户手动添加方法
    • 腾讯会议: 预置腾讯会议的创建、查询、取消等方法, 需 Oauth 授权微搭访问腾讯会议. 注意: 据腾讯会议要求, 腾讯会议的企业用户在授权微搭时需要企业的腾讯会议管理会管理员配置后方可正常授权使用.
    • 腾讯文档: 预置操作腾讯文档表格相关方法, 需 Oauth 授权微搭访问腾讯文档
  • 配置导入: 使用第三方 HTTP API 描述文件来创建数据源. 目前支持以下几种格式:

公共变量#

数据源里的方法可能会有一些公共固定的参数: 前端应用使用时并不需要传递, 但调用第三方接口又需要, 比如:

  • 调用第三方数据源需要的认证信息, 如 Access-Token, Secret-Key
  • 来源标识信息, 如 AppID, AffiliateID
  • 其他业务相关的公共参数

这些公共的固定参数, 可以在公共变量中添加. 在数据源的方法中, 根据方法类型不同, 使用公共变量的方式也有不同:

  • HTTP请求 中, 可在 HTTP配置的值中使用 {{vars.<公共变量的key>}}来使用对应公共变量的值, 具体可参考 HTTP请求
  • 云函数 中, 可在函数代码中通过 context.vars.<公共变量的key>来使用对应公共变量的值, 具体可参考 云函数context

添加数据源自定义方法#

若内置数据源方法不满足需要, 可添加自定义方法, 具体可参考 添加数据源自定义方法