全局统一返回说明

为了确保接口调用方能够统一、高效地处理API响应，所有接口均遵循统一的数据返回格式。返回的数据为JSON格式，包含了业务数据、状态码和提示信息。

响应格式

所有API的响应都将遵循以下JSON结构：

{
  "data": {},
  "code": 1,
  "msg": "操作成功"
}

字段名	类型	描述
`data`	object	业务数据：请求成功时返回的核心数据。其具体结构和内容会根据不同接口的定义而变化。如果请求失败或没有特定数据返回，此字段可能为 `null` 或 `{}`。
`code`	int	状态码：用于标识请求处理结果的数字代码。调用方应首先检查此字段以确定后续操作。常见状态码如下： - `1`: 请求成功处理。 - `401`: 未授权。请求头中缺少、无效或过期的`Authorization`凭证。 - 其他非1值: 表示各类业务或系统错误。
`msg`	string	提示信息：对本次请求结果的文本描述。无论是成功还是失败，此字段都会提供简明扼要的信息，便于开发者快速定位问题或了解操作结果。

当一个请求被成功处理时，code 将为 1，data 字段会包含请求的业务数据。

{
  "data": {
    "userId": "12345",
    "username": "exampleUser"
  },
  "code": 1,
  "msg": "用户查询成功"
}

当请求处理过程中发生错误时，code 将为非 1 的值，msg 字段会提供具体的错误信息，data 字段通常为 null。

示例：未授权

{
  "data": null,
  "code": 401,
  "msg": "请求未授权，请检查您的API密钥是否正确并在请求头中提供有效的Authorization。"
}

示例：业务逻辑错误

{
  "data": null,
  "code": 5001,
  "msg": "参数 'username' 不能为空。"
}