返回结果
本文主要介绍 API 接口返回结果的消息体结构和消息体中各字段说明。
消息体结构
下面以新建目录接口为例，介绍返回结果的消息体结构，包括正确返回结果和错误返回结果：
- 正确返回结果
{
"status": 200,
"message": "success",
"data": {
"id": "40708c7bcf0e4d89a0d26ca6cb2e3817",
"path": "/example"
},
"fieldErrors": null
}
- 错误返回结果
{
"status": 1,
"message": "should not be empty",
"data": null,
"fieldErrors": "name"
}
消息体说明
消息体结构中各字段说明如下：
| 字段 | 说明 |
|---|---|
| status | 状态码。接口正常时返回 200；接口异常时返回 1 |
| message | 状态信息。接口正常时返回 success；接口异常时返回错误的详细信息 |
| data | 具体业务数据。接口正常时返回业务数据；接口异常时返回 null |
| fieldErrors | 错误信息。接口正常时返回 null，接口异常时返回错误字段 |
京公网安备11010802043204号