Are you an LLM? You can read better optimized documentation at /v3/backend/index.md for this page in Markdown format
后端文档
欢迎来到 MineAdmin 3.x 后端开发文档。这里主要描述 MineAdmin v3 的公共契约:前台模板、后台路由、接口元数据、响应结构和数据模型等稳定约定。具体框架实现已经独立到 后端框架实现。
阅读路径
如果你只关心业务开发,建议先阅读公共契约,再进入当前项目使用的框架实现:
- 公共契约:了解所有后端实现必须保持一致的接口、模型和响应规范。
- Hyperf latest:当前指向 Hyperf 3.2,包含生命周期、中间件、异常处理、日志、事件、上传、多语言、认证授权和数据权限等细节。
- Laravel 1.0:规划中实现入口,后续 Laravel 版本将复用同一套公共契约。
架构原则
MineAdmin 的后端实现可以由不同框架承载,但面向前台模板和外部集成时需要保持一致:
- 数据模型语义一致:用户、角色、菜单、部门、岗位、附件等核心模型保持同一业务含义。
- 后台路由一致:同类后台资源使用一致的路由语义、权限标识和操作边界。
- 接口元数据一致:OpenAPI/Swagger 元数据需要描述同一套请求、响应和认证要求。
- 响应结构一致:接口统一返回业务状态码、消息和数据载荷,避免前台因框架差异分支处理。
- 前台模板一致:同一套前台模板可以通过同一套接口契约对接不同后端实现。
当前实现状态
| 实现 | 版本 | 语言 | 状态 | 说明 |
|---|---|---|---|---|
| Hyperf | 3.2 | PHP | latest / 稳定实现 | MineAdmin 3.x 当前默认后端实现,运行在 Swoole/Swow 协程环境中。 |
| Hyperf | 3.1 | PHP | 稳定实现 | 与 3.2 初始文档结构一致,后续按版本差异维护。 |
| Laravel | 1.0 | PHP | 规划中 | 第一阶段只保留入口,后续按公共契约补齐实现文档。 |
核心专题
- Hyperf 用户认证:双 Token、JWT 与登录流程。
- Hyperf 用户授权(RBAC):角色、菜单、权限校验与审计。
- Hyperf 数据权限:部门、岗位、策略和数据过滤规则。
- 插件开发:通过插件机制扩展系统功能。