喂食记录鉴权接口文档
概览
- 基础路径: /api
- 文档范围: 鉴权路由中的喂食记录接口
- 鉴权方式: 请求头 X-Token
- Content-Type: application/json
鉴权头
| 字段 |
类型 |
必填 |
说明 |
| X-Token |
string |
是 |
用户登录后获得的 JWT Token |
统一响应格式
{
"code": 200,
"msg": "操作成功",
"data": {}
}
返回字段说明
| 字段 |
类型 |
说明 |
| code |
integer |
业务状态码，200 表示成功，其他值表示失败 |
| msg |
string |
响应消息 |
| data |
object/array/null |
业务数据 |
通用鉴权失败响应
{
"code": 401,
"msg": "未登录或登录过期",
"data": null
}
{
"code": 401,
"msg": "登录已过期，请重新登录",
"data": null
}
喂食记录对象字段说明
| 字段 |
类型 |
说明 |
| deviceId |
string |
设备唯一标识 |
| userId |
integer |
执行用户 ID |
| userName |
string |
执行用户昵称 |
| planId |
integer |
关联计划 ID，手动喂食时通常为 0 |
| amount |
integer |
喂食份量 |
| feedTime |
integer |
喂食时间戳，秒 |
| createdAt |
string |
创建时间 |
1. 获取喂食记录
- 路径: /api/feeding/logs
- 方法: POST
- 是否鉴权: 是
请求 Body 参数
| 字段 |
类型 |
必填 |
说明 |
| deviceId |
string |
是 |
设备唯一标识 |
| limit |
integer |
否 |
返回记录条数。当前实现中，不传或小于等于 50 时按 50 处理；大于 200 时最终按 200 返回 |
请求示例
{
"deviceId": "dev_001",
"limit": 100
}
成功响应示例
{
"code": 200,
"msg": "操作成功",
"data": [
{
"deviceId": "dev_001",
"userId": 1,
"userName": "小明",
"planId": 12,
"amount": 20,
"feedTime": 1752297600,
"createdAt": "2026-05-09T10:00:00Z"
}
]
}
返回参数说明
| 字段 |
类型 |
说明 |
| code |
integer |
成功时为 200 |
| msg |
string |
成功时为 操作成功 |
| data |
array |
喂食记录列表 |
| data[].* |
object |
喂食记录对象，字段见上方喂食记录对象字段说明 |
失败响应示例
{
"code": 400,
"msg": "参数错误",
"data": null
}
{
"code": 500,
"msg": "获取喂食记录失败",
"data": null
}
附录
说明
- 获取喂食记录返回数组；无数据时返回空数组，而不是 null。
- limit 最终上限由 service 控制为 200.