Are you an LLM? You can read better optimized documentation at /v3/backend/contracts/frontend-template.md for this page in Markdown format
前台模板对接契约
前台模板对接契约用于保证同一套 MineAdmin 前台模板可以连接不同后端实现。只要后端实现遵守公共契约,前台不应因为底层框架不同而维护多套请求逻辑。
对接边界
前台模板主要依赖以下稳定能力:
- 登录、刷新 Token、退出登录等认证接口。
- 用户信息、菜单、权限按钮和角色能力。
- 后台资源的列表、详情、创建、更新、删除接口。
- 数据权限过滤后的业务数据。
- 文件上传、附件访问和导入导出接口。
- 统一响应结构和错误提示规则。
模板一致性
不同后端实现需要保持以下一致:
- 接口路径和 HTTP 方法一致。
- 权限标识和菜单编码一致。
- 请求参数和响应字段一致。
- 分页、筛选、排序的参数语义一致。
- 文件上传字段、返回附件结构和访问地址语义一致。
框架差异处理
框架差异应收敛在后端实现层,例如路由注册方式、中间件名称、ORM 事件、异常处理器、队列和文件系统配置。前台模板不应感知这些差异。
当某个框架实现无法完全复用公共契约时,需要在对应实现页明确标注差异,并同步说明前台模板是否需要额外适配。