Skip to content

API 总览

业务接口在 src/business/controller,由装饰器或函数式 Application.GET/POST 注册。统一响应:

json
{
  "code": 200,
  "message": "操作成功",
  "data": null
}

分页请求体常见形态:{ "pageNum": 1, "pageSize": 10, "form": { ... } }

模块一览

模块前缀说明
User/api/user登录、资料、用户 CRUD、绑角色
Role / Menu/api/role/api/menu角色菜单与动态路由
Log/api/log操作日志分页与导出
SysConfig/api/sys_config公开配置与后台配置管理
File / AES/api/file/api/aes上传与动态 AES 密钥
Schedule/api/schedule定时任务 CRUD / 启停 / 执行
TableConfig / MockData/api/table_config/api/mock_data微数据工具
Test/api/testORM / @Select 演示

鉴权说明

入口 Auth 全局忽略:

  • /api/user/login
  • /api/user/check_login
  • /api/sys_config/public
  • /api/aes/key

其余接口默认需登录;再按角色 / 权限细分(如 ROLE_adminsystem:user:create)。Token 放在 Authorization 头(可为裸 token,与当前 UI 一致)。

开启加密传输时,前端需先拉 /api/aes/key,再按 加密传输 约定加解密。

新增业务模块

完整走读见 使用案例。步骤:

  1. entitymapperservicecontroller
  2. 需要写操作日志 / 限流 / 防重时加 @Log / @RateLimiter / @RepeatSubmit
  3. 重启 npm run dev(启动扫描加载)

基于 VitePress 构建