跳到主要内容

API 与数据集：拉配置、看清数据

这一节解决两类问题： **本地 api.ts 怎么来 ，以及 平台上到底有哪些数据集、字段是什么、能调哪些操作 **。前提：已完成登录，且当前 App Code、环境正确（见“配置：应用、环境、多应用”）。

为什么要先 api pull​

前端里用到的数据集别名、请求封装，通常来自项目里的 **API 目录 **（默认 ./src/api/，可在配置里改 apiDir）。和平台不一致时，会出现「代码里写的别名对不上」「拉列表报错」之类问题。习惯上在以下时机拉一次：

  • 刚接入项目、project init 之后
  • 平台上增删改过数据集或模型
  • 切换了 appcode / env

命令：

rabetbase api pull

指定输出目录：

rabetbase api pull --output ./src/api

拉下来之后，本地会有一份和当前 App 对齐的模型列表，后面的 codegen、dataset --alias 等都会用到这里的别名。

列出当前应用下所有模型（数据集）​

有时你想在终端快速看一眼，不必打开文件：

rabetbase api list

多应用模式下会按配置逐个 App 列出（具体输出格式可用 --format json / table）。

按数据集做只读探查​

列出数据集（支持服务端过滤，不必全量硬拉）：

rabetbase dataset list
rabetbase dataset list --name 订单
rabetbase dataset list --code <32位code>

看某一个数据集的完整信息（字段、元数据等）：

rabetbase dataset detail --code <32位code>

若已经 api pull 过，可以用 别名 代替长 code：

rabetbase dataset detail --alias order

只看这个数据集有哪些操作（filter、getOne、create 等）：

rabetbase dataset operations --alias order
rabetbase dataset operations --alias order --operation filter

带 --operation 时可以看到该操作的参数定义，写 BFF 或 codegen 时很有用。

摸清表与表之间的关系​

要做跨表查询、写复杂 SQL、或让 AI 帮你写脚本时，先搞清楚「谁连谁」会省很多返工：

rabetbase dataset links

可按数据库筛：

rabetbase dataset links --db

返回里会有字段、主外键、数据集之间的关联类型等。需要原始响应可加 --verbose。

生成面向文档的 API 说明（可选）​

如果要把当前数据集的接口说明导出成文档（默认目录与选项以 rabetbase api doc --help 为准）：

rabetbase api doc
rabetbase api doc --datasetcode ds1,ds2

适合给同事或留档，和日常写业务代码不冲突。

小结​

  • api pull：让本地 API 配置与平台一致。
  • api list：终端里扫一眼模型列表。
  • dataset list / detail / operations：从粗到细看单个数据集。
  • dataset links：看库表与数据集关联，写 SQL / BFF 前先跑一遍很值。

下一步：要写平台托管的自定义 SQL，读 自定义 SQL：从写到执行。