模块说明
favorites 提供会员收藏能力:查看收藏列表(附内容跳转地址)、加入收藏(幂等)、取消收藏。
鉴权级别:收藏操作全部必须登录。
接口一览
| 方法 |
URL |
鉴权 |
说明 |
| GET |
/api/favorites |
公开 |
模块入口(占位,返回空数据) |
| GET |
/api/favorites/user |
必须 |
我的收藏列表 |
| POST |
/api/favorites/user |
必须 |
加入收藏(重复调用幂等) |
| POST |
/api/favorites/user/destroy |
必须 |
取消收藏 |
我的收藏列表 GET /api/favorites/user
{
"code": "OK",
"message": "",
"data": {
"title": "我的收藏",
"favorites_list": [
{ "id": 1, "module_id": "product", "item_id": 12, "url": "pages/product/show?id=12", "...": "" }
],
"pager": { "...": "分页信息" },
"total": 3
},
"errors": {},
"request_id": "9f2a5c8e1b3d7f40"
}
列表每项的 url 为小程序形态跳转地址(Url::urlMini 生成),通用客户端可忽略并自行拼接,或基于 module_id + item_id 跳转。
加入收藏 POST /api/favorites/user
| 参数 |
必填 |
说明 |
module |
否 |
模块名,默认 product |
item_id |
是 |
内容 ID |
{
"code": "OK",
"message": "收藏成功",
"data": {
"favorites": true,
"text": "已收藏"
},
"errors": {},
"request_id": "9f2a5c8e1b3d7f40"
}
- 幂等:已收藏时再次调用返回
200,message 为 OK(仅当本次真正新增时返回成功文案与 text);
data.favorites 为收藏状态布尔值,可直接用于按钮态渲染。
取消收藏 POST /api/favorites/user/destroy
| 参数 |
必填 |
说明 |
id |
是 |
收藏记录 ID(非内容 ID) |
| 场景 |
响应 |
| 记录不存在或不属于当前会员 |
404 NOT_FOUND |
| 成功 |
200 OK,message=success |
注意事项
- 取消收藏需传收藏记录 ID(列表项
id),而非内容 ID;
- 模块名(
module)允许扩展 ID 形态(字母数字下划线),非法值回退 product。