业务中台标准接口¶
📄 创建: ZCode AI 2026-08-14 · 修改: JimWb 2026-08-14
bams-apex 业务中台提供的全部 REST 接口(55 个 Controller,dev 分支)。基于真实源码提取,按业务域分文档。
全局信息¶
| 项 | 值 |
|---|---|
| 服务 | bams-apex 业务中台 |
| Base URL | /apex-api |
| 鉴权 | 登录后 Header sessionid(登录接口返回 data.sessionId) |
| 响应格式 | JsonResult:{code, msg, data},code="200" 成功 |
| 命名 | 响应属性 snake_case |
通用规范(标准 CRUD 21 个接口、查询参数格式、分页格式)见 标准CRUD接口规范。
接口分域导航¶
| 域 | 文档 | Controller 数 | 核心能力 |
|---|---|---|---|
| 系统管理 | sys.md | 15 | 登录认证、用户/角色/菜单/按钮权限/应用管理、租户数据源 |
| 消息中心 | pub-message.md | 28 | 消息模板/发送配置/站内信/短信/邮件/企微/通知公告/日志 |
| 基础数据 | base.md | 9 | 公司/部门/人员/岗位/计量单位/字典/单位换算 |
| 文件上传 | file.md | 1 | 本地存储文件上传/删除/Base64 |
| 流程模板 | flow.md | 1 | LiteFlow 规则模板生命周期(初始化/发布/激活) |
| 平台网关 | gate.md | 1 | 底座单点登录入口/免密换 token |
Controller 清单速查(55 个)¶
系统管理(15 个)¶
| 前缀 | 模块 | 类型 |
|---|---|---|
/dac/sysUser |
系统用户(登录 loginByPassword) | 标准+自定义 |
/dac/sysApp |
应用管理 | 标准+10自定义 |
/sys/role |
角色管理 | 标准+4自定义 |
/sys/sysResource |
系统资源/菜单 | 标准+2自定义 |
/dac/sysAppRole |
应用角色关联 | 完全自定义 |
/sys/roleButton |
角色按钮权限 | 完全自定义 |
/sys/roleResource |
角色菜单关联 | 完全自定义 |
/sys/userRole |
用户角色关联 | 完全自定义 |
/sys/businessStatus |
业务状态配置 | 标准+1自定义 |
/sys/button /sys/config /sys/menuButton |
按钮/配置/菜单按钮 | 纯标准 |
/sys/log /sys/operLog |
系统日志/操作日志 | 标准+重写 |
/sys/tenantDb |
租户数据源 | 纯标准 |
消息中心(28 个)¶
详见 pub-message.md。核心:/pub/msgTemplate(消息模板)、/pub/notifyMessage(站内信+确认)、/pub/versionInfo(版本采集)、其余为配置/日志类标准 CRUD。
基础数据(9 个)¶
详见 base.md。
文件上传 / 流程模板 / 平台网关(3 个)¶
前端最常用接口 TOP 10¶
| 场景 | 接口 |
|---|---|
| 登录 | POST /apex-api/dac/sysUser/auth/loginByPassword(form 参数) |
| 获取 session 用户 | GET /apex-api/dac/sysUser/transferToLocalUser?sessionId= |
| 菜单树 | GET /apex-api/dac/sysUser/getResourceByUserTree?appId=&token=&accountId= |
| 按钮权限 | GET /apex-api/sys/roleButton/getButtonsBySessionId?sysCode= |
| 应用列表(门户) | GET /apex-api/dac/sysApp/getAppListByUserType |
| 通用分页查询 | POST /apex-api/{模块}/list(BasicParamWrapper) |
| 通用保存 | POST /apex-api/{模块}/saveOrUpdate |
| 通用删除 | POST /apex-api/{模块}/delete/{id} |
| 我的站内信 | POST /apex-api/pub/notifyMessage/list |
| 确认弹窗消息 | POST /apex-api/pub/notifyMessage/confirmNotifyMessage |