Are you an LLM? You can read better optimized documentation at /v3/backend/contracts/response.md for this page in Markdown format
响应结构契约
响应结构契约定义 MineAdmin API 的统一返回格式。不同框架实现可以使用不同的响应对象或异常处理器,但对外返回的数据结构需要保持一致。
基础结构
标准响应包含三个核心字段:
json
{
"code": 200,
"message": "操作成功",
"data": {}
}1
2
3
4
5
2
3
4
5
| 字段 | 说明 |
|---|---|
code | 业务状态码,用于表达业务处理结果。 |
message | 面向用户或开发者的结果说明。 |
data | 响应数据,可以是对象、数组、分页结构或空对象。 |
HTTP 状态码用于表达传输层结果,code 用于表达业务层结果。前台模板应优先根据业务状态码和约定的异常处理流程展示提示。
分页结构
分页接口应在 data 中返回列表和分页信息,字段命名应在同一产品版本内保持稳定。不同框架实现可以在内部使用不同分页器,但不能改变前台依赖的最终结构。
错误结构
业务错误、验证错误、未认证、未授权和系统错误都应进入统一响应结构。框架实现需要把自身异常转换为稳定的业务响应,避免直接暴露底层框架异常格式。
多语言消息
业务消息可以由后端实现根据客户端语言生成,但消息键、业务状态码和错误语义应保持一致。框架具体多语言加载方式见对应实现文档。
框架实现
Hyperf 当前通过 Result、ResultCode 和异常处理器统一响应结构,具体用法见 Hyperf 错误处理。