Are you an LLM? You can read better optimized documentation at /v3/backend/contracts/index.md for this page in Markdown format
公共契约
公共契约用于描述 MineAdmin 后端实现之间必须保持一致的部分。无论底层使用 Hyperf、Laravel,还是未来其他语言或框架,面向前台模板、插件和外部系统时都应遵守这些约定。
契约范围
| 契约 | 说明 |
|---|---|
| 数据模型 | 核心业务实体、关系和字段语义保持一致。 |
| 后台路由 | 后台资源、权限标识、操作语义和认证边界保持一致。 |
| 接口元数据 | OpenAPI/Swagger 元数据描述同一套请求和响应。 |
| 响应结构 | API 返回结构、业务状态码、错误消息和分页载荷保持一致。 |
| 前台模板对接 | 前台模板通过稳定接口契约对接不同后端实现。 |
与框架实现的关系
公共契约只描述“必须一致”的行为,不绑定具体框架 API。框架实现文档负责说明这些契约在对应框架中的落地方式,例如中间件注册、服务容器、生命周期、事件系统、异常处理和文件上传配置。
当前稳定实现是 Hyperf 实现,Laravel 入口已在 Laravel 实现 中预留。