Skip to content

即时API(Instant API)

Instant API 是每个 Lovrabet dataset 自动具备的数据接口层。只要 dataset 已经存在,平台就可以围绕这个 dataset 提供 9+ 个常用 API,用于列表查询、详情读取、写入、批量写入、统计、选项数据和导出。

它的关键价值不是“少写几个 CRUD 接口”,而是让页面、服务端任务、第三方系统和 Agent 都沿着同一个业务模型工作。DBAgent 会先还原业务对象和业务关系,后续 Instant API、SDK、页面和 Backend Function Hooks 才能共享同一套业务语义。

1. Instant API 解决什么问题

问题没有 Instant API 时使用 Instant API 后
列表页每张表都要手写列表接口直接调用 filter
详情页手写按 ID 查询接口直接调用 getOne
表单提交手写新增、更新、删除接口直接调用 create / update / delete
批量导入前端循环调用 create 或自建批量接口直接调用 batchCreate
统计看板一开始就写 SQL 或 BFF先用 aggregate 覆盖常见统计
下拉框为每个选择器写 options 接口直接调用 getSelectOptions
导出页面筛选和导出逻辑分叉excelExport 复用查询条件

2. 标准执行链路

Plain
页面 / 服务端 / Agent / 第三方系统
        |
        v
SDK / OpenAPI / Runtime CLI
        |
        v
Before Hook
        |
        v
Instant API
        |
        v
After Hook
        |
        v
JSON / 文件 URL / 业务结果

Before Hook 和 After Hook 不是每次都必须写。默认情况下,Instant API 可以直接使用;当业务需要统一校验、鉴权、脱敏、补字段时,再把规则放进 Hook。

3. 三种常见调用方式

调用方式适合场景典型入口
TypeScript SDKWeb、Node.js、SSR、小程序、Agent 运行时client.models.orders.filter(...)
Java OpenSDKSpring Boot、Java 服务、批任务、企业系统集成LovrabetSDKClient
Runtime CLI调试、自动化脚本、Agent 工具执行lovrabet data filter --code ...
OpenAPI第三方系统、非 SDK 语言、外部服务AccessKey + HTTP

4. 与 Backend Function 的边界

Instant API 面向单个 dataset 的标准动作。只要业务目标能表达为“查、改、统计、导出某个 dataset”,优先用 Instant API。

当一次业务动作需要跨多个 dataset、调用外部服务、做事务编排、补偿或异步处理时,再使用 Backend Function Endpoint。Endpoint 可以在内部继续调用 Instant API,但它本身是更高一层的业务编排入口。

5. 命名约定

统一使用 Instant API。不要再把这组能力称为“标准接口”“即时 OpenAPI”或“自动 CRUD 接口”。在兼容旧文档时,可以说明旧称对应关系,但新文档和产品页都应使用 Instant API

基于飞书知识库同步生成,内容以飞书源文档为准