标准接口¶

📄 创建: ZCode AI 2026-08-14 · 修改: JimWb 2026-08-14

https://doc.xpku.com/raw/tech/backend/api-standards/index.md

本目录沉淀 BAMS 体系的标准接口文档，面向前端开发与前端 AI 快速调用。分两部分：

目录结构¶

部分	内容	适用场景
标准CRUD接口规范	系统统一封装的 21 个增删改查/条件查询接口模式：统一响应格式、BasicParamWrapper 查询参数、分页格式、鉴权方式	前端对接任何标准业务模块；AI 按规范生成调用代码
业务中台标准接口	bams-apex 业务中台提供的全部 REST 接口（55 个 Controller，按域分文档）	查具体业务模块的接口定义、参数、返回值

快速导航¶

我要对接一个标准业务模块（增删改查）¶

→ 直接看标准CRUD接口规范。所有标准模块的接口模式完全一致，只需知道模块路径前缀。

我要查某个具体接口（登录/发消息/文件上传）¶

→ 看业务中台标准接口： - 系统管理 — 登录/用户/角色/菜单/应用 - 基础数据 — 公司/部门/人员/岗位/单位/字典 - 消息中心 — 消息/短信/邮件/通知 - 文件上传 — 文件上传/删除/Base64 - 流程模板 — LiteFlow 规则模板生命周期 - 平台网关 — 底座单点登录入口

我是 AI 助手，要生成前端调用代码¶

→ 先读标准CRUD接口规范的「AI 快速调用指南」章节，里面有关键约定（snake_case、sessionid header、code 判断）和完整调用序列示例。

全局速记¶

Base URL:   /apex-api
鉴权:       Header sessionid（登录接口返回）
响应:       { code, msg, data }  code="200" 成功
命名:       响应属性 snake_case（created_time）
查询条件:   andMap/likeMap/geMap/leMap/inMap/orderBy（key=数据库列名）
分页:       current/size（不传 size=查全部）