参数、分页与响应
# 参数、分页与响应
列表使用 offset 分页。请求里 pageNo 从 1 开始,上限 1000000;pageSize 默认 20,允许 1 到 100。响应里的 data 使用 list、total、pageNo、pageSize。空列表是 [],不是 null。
时间范围使用 from 和 to,左闭右开。时间在库内按 UTC 毫秒保存,接口使用 RFC3339。当前没有租户时区配置,页面用浏览器时区输入和展示。
ID 是字符串。状态使用字符串枚举,例如 enabled 和 disabled,不使用 0 和 1。树节点含 id、parentId 和 children,根的 parentId 为 null,叶子可以不带 children。
更新和删除携带资源当前的整数 version。归属租户由服务端根据登录身份决定,请求体不能指定其他租户。未知字段会被拒绝。响应不包含口令散列、token 摘要和内部错误栈。
排序字段只能使用该接口公布的白名单,sortOrder 为 asc 或 desc。用户输入不会直接拼进 SQL。
删除的正文是空 JSON 对象。生产环境中,GET 的查询参数放在 X-Fago-Payload,写请求的正文是 application/jose,URL 上不保留明文查询。开发环境仍使用普通 query 和 JSON。
列表查询示例(开发环境明文 query):
GET /api/admin/v1/system/users?pageNo=1&pageSize=20&keyword=admin
Origin: http://127.0.0.1:5174
X-App-Request: admin
Authorization: Bearer <access>
{
"code": 0,
"data": {
"list": [],
"total": 0,
"pageNo": 1,
"pageSize": 20
},
"message": "ok",
"requestId": "req_example"
}
最后更新: 2026/10/28 10:34:52