SDK 与 Runtime CLI 调用指南
Instant API 可以通过 TypeScript SDK、Java OpenSDK、OpenAPI 和 Runtime CLI 调用。业务开发优先使用 SDK;调试和自动化任务可以使用 CLI;第三方系统和特殊语言环境可以使用 OpenAPI。
1. 正式参考文档
| 文档 | 用途 |
|---|---|
| TypeScript SDK | Node.js / TypeScript SDK 的完整接入、模型配置、认证和方法说明 |
| Java SDK | Java 服务端接入、请求对象、认证和调用示例 |
| OpenAPI | OpenAPI 认证、签名、路径、请求体和完整接口说明 |
2. TypeScript SDK
下面只保留最小调用示例。完整安装、配置、认证、类型和错误处理请看 TypeScript SDK。
安装:
Bash
npm install @lovrabet/sdk推荐先通过 Rabetbase CLI 同步模型配置:
Bash
rabetbase api pull典型调用:
TypeScript
import { registerModels, createClient } from "@lovrabet/sdk";
import "./api/api";
const client = createClient({
accessKey: process.env.LOVRABET_ACCESS_KEY,
});
const orders = await client.models.orders.filter({
where: { status: { $eq: "pending" } },
currentPage: 1,
pageSize: 20,
});模型访问有两种方式:
| 方式 | 示例 | 说明 |
|---|---|---|
| dataset key | client.models.dataset_<datasetCode> | 稳定、唯一,适合生成代码和 Agent |
| alias | client.models.orders | 可读性更好,依赖模型配置里的 alias |
3. Java OpenSDK
Java OpenSDK 适合企业后端服务、批任务和系统集成。现有 Java 文档以 LovrabetSDKClient 和 LovrabetRequest 为主,核心能力覆盖 dataset 列表、单条读取、新增、更新等。
Java SDK 详细接入请看 Java SDK。Instant API 文档只说明能力边界和调用心智,不复制 Java SDK 的完整 Reference。
4. Runtime CLI
Runtime CLI 适合调试、自动化脚本和 Agent 工具执行。
Bash
lovrabet data filter --code <datasetCode> --params '{"where":{"status":{"$eq":"active"}},"currentPage":1,"pageSize":20}'
lovrabet data getOne --code <datasetCode> --params '{"id":123}'
lovrabet data aggregate --code <datasetCode> --params '{"aggregate":[{"field":"id","type":"COUNT","alias":"cnt"}],"groupBy":["status"]}'
lovrabet data create --code <datasetCode> --params '{"name":"test"}'
lovrabet data update --code <datasetCode> --params '{"id":123,"status":"completed"}'
lovrabet data delete --code <datasetCode> --params '{"id":123}' --yes写操作建议先使用 --dry-run:
Bash
lovrabet data update --code <datasetCode> --params '{"id":123,"status":"completed"}' --dry-run5. 认证方式
| 场景 | 推荐方式 |
|---|---|
| 平台内页面 | WebAPI / 用户态 Cookie 或 token |
| 服务端任务 | AccessKey |
| 第三方系统 | OpenAPI + AccessKey |
| CLI 调试 | 按 lovrabet CLI 当前配置和登录态 |
具体配置以 TypeScript SDK、Java SDK 和 OpenAPI 文档为准。Instant API 文档只负责解释能力边界和调用心智。