Playground 用法

不写一行前端,直接对着生成的 API 发请求、看响应;一键导出 Postman / cURL / OpenAPI。

Playground 是内嵌的 HTTP 测试工具,让你不写前端就能验证生成的接口。它预置了每个表的全部端点,选端点、填参数、发送,三步完成;验证通过后还能把整套接口一键导出为 Postman Collection、cURL / Fetch 脚本或 OpenAPI Schema,直接拿去联调,交付接口API。

Playground 界面

预置端点

每张表都自动生成以下端点:

端点方法路径说明
ListPOST/list分页条件查询
GetGET/{id}按 ID 查询
ListByIdsPOST/listByIds按 ID 批量查询
CreatePOST/批量插入
UpdatePUT/{id}按 ID 更新
DeleteDELETE/{id}按 ID 删除
CountPOST/count条件计数

另外,被标记为**唯一(非主键)**的字段会自动生成对应的 FindBy-{字段} 端点(GET /by-{字段}/{值}),按该唯一字段精确查询——例如 email 是唯一字段,就有一个 FindBy-Email。

这些端点与生成的 REST API 一一对应,摸清它们,对接前端时就心里有数。

怎么用

  1. 选端点:在端点列表里选一个(如 Create 或 List)
  2. 填参数:哪些字段可写,由表的可插入/可修改属性决定;需要时填路径参数(ID)
  3. 加请求头 / 请求体:需要的话自定义请求头,或编辑请求体 JSON
  4. 发送:点发送,下方实时显示响应状态、响应体

发送请求

一次完整示例

以 users 表为例:

  1. 选 Create,填入 {"name": "张三", "email": "z@example.com"}
  2. 发送 → 返回创建成功与记录 ID
  3. 选 List,发送 → 返回分页列表,能看到刚插入的数据

这样一条“插入 → 查询”的闭环就验证完了,不需要任何前端代码。

导出接口

把整套接口一键导出,方便拿去联调、分享或导入 API 工具。点右上角「Export」按钮,选一种格式:

导出文件名用途
📮 Postman Collectionpostman-collection.json导入 Postman,逐个接口直接测试
💻 cURL 脚本api-curl.sh命令行请求脚本,终端里快速验证
📦 Fetch 脚本api-fetch.js前端 fetch 调用示例,可照搬进项目
📐 OpenAPI Schemaopenapi.json标准 OpenAPI 描述,可导入其他 API 工具或生成客户端

导出内容覆盖每张表的全部预置端点:List / Get / ListByIds / Create / Update / Delete / Count,以及唯一字段的 FindBy 查询。请求地址默认指向本地运行的后端(localhost:3000),导入后按需修改。

导出的是接口清单与调用示例;每个接口实际返回哪些字段,仍以表配置与权限为准(见《权限对接方法》)。

提示

  • List / Count 支持条件过滤:在请求体里组合过滤条件、比较运算符、范围与嵌套条件
  • 每个接口返回的字段,受表配置与权限设置影响(见《权限对接方法`)