Fago 文档 Fago 文档
首页
快速开始
后端手册
前端手册
规划备查
文档维护
首页
快速开始
后端手册
前端手册
规划备查
文档维护
  • 快速开始

    • 简介
    • 功能列表
    • 快速启动(后端)
    • 快速启动(前端)
    • 技术选型
    • 项目结构
    • 接口与错误码
  • 后端手册

    • 配置与环境
    • 登录与会话
    • 功能权限与菜单
    • 数据权限
    • 用户、部门、岗位与角色
    • 租户与安全策略
    • 异常处理与错误码
    • 参数、分页与响应
    • 数据库迁移
    • 日志、脱敏与请求加密
    • 平台租户与套餐
    • fago-cli 常用命令
    • 发布验证与恢复演练
    • 字典与参数配置
    • 文件与对象存储
    • 站内通知与执行恢复
    • 定时任务与运行恢复
    • 可靠消息后端与积压观测
    • 身份客户端与设备会话
    • 会员认证与账号管理
    • 服务账号与 scope
    • OIDC 提供方与外部绑定
    • 原生 SSO 验收客户端
    • 账号认证模式
    • 工作流 API 与运行目录
  • 前端手册

    • 本地启动
    • 菜单与路由
    • 请求合同
    • 页面与按钮权限
    • 浏览器单点登录
    • 审批中心与表单发起
    • 工作流定义与运行管理
  • 规划备查

    • Fago:架构与实施方案
    • 总体架构
    • 身份、权限与租户设计
    • Vben 5 前端与 API 合同
    • 数据库与消息后端适配
    • 纯 Go 通用工作流:文件、文档与业务流程
    • 核心数据模型
    • 分期、工作包与验收
    • 架构决策与风险
    • 参考来源与基线
    • 网络安全等级保护二级合规要求
    • M0 实施与验收
    • M1 身份与导航实施及验收
    • 项目配置、API 内容加密与敏感数据脱敏
    • M2 系统管理实施记录
    • M3 平台与 SaaS 实施记录
    • fago-cli 功能规划
    • 生产传输层 WARN 变更范围(2026-10-23)
    • M4 发布实施与验收
    • M4 加固检查归档(本地工程环境)
    • M5 通用平台与身份实施
    • M6 R3.1 正式工作流核心与基础审批

参数、分页与响应

# 参数、分页与响应

列表使用 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
异常处理与错误码
数据库迁移

← 异常处理与错误码 数据库迁移→

Theme by Vdoing | Copyright © 2026-2026 Fago 项目文档
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式