Skip to content

7 Favorite

收藏功能介绍

当用户访问首页时，首先需要加载不同分类的新闻数据，进而进入详情页查看具体新闻内容。

收藏模块主要实现以下功能:

  • 添加收藏
  • 取消收藏
  • 收藏列表获取
  • 清空所有收藏
  • 检查收藏状态

API接口介绍

1 添加收藏

功能描述：添加新闻到收藏列表

请求方式：POST

接口地址：/api/favorite/add

请求头：

参数名 类型 必填 描述
Authorization String 是 用户令牌

请求参数：

参数名 类型 必填 描述
newsId Number 是 新闻ID

响应参数：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "code": 200,
  "message": "收藏成功",
  "data": {
    "id": 1,
    "userId": 1,
    "newsId": 1,
    "createTime": "收藏时间"
  }
}

2 取消收藏

功能描述：从收藏列表中移除新闻

请求方式：DELETE

接口地址：/api/favorite/remove

请求头：

参数名 类型 必填 描述
Authorization String 是 用户令牌

请求参数：

参数名 类型 必填 描述
newsId Number 是 新闻ID

响应参数：

1
2
3
4
5
{
  "code": 200,
  "message": "取消收藏成功",
  "data": null
}

3 获取收藏列表

功能描述：获取用户的收藏新闻列表

请求方式：GET

接口地址：/api/favorite/list

请求头：

参数名 类型 必填 描述
Authorization String 是 用户令牌

请求参数：

参数名 类型 必填 描述
page Number 否 页码，默认1
pageSize Number 否 每页条数，默认10

响应参数：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "code": 200,
  "message": "success",
  "data": {
    "list": [
      {
        "id": 1,
        "title": "新闻标题",
        "description": "新闻简介",
        "image": "图片URL",
        "author": "作者",
        "publishTime": "发布时间",
        "categoryId": 1,
        "views": 1000,
        "favoriteTime": "收藏时间"
      }
    ],
    "total": 10,
    "hasMore": false
  }
}

4 检查文章收藏状态

功能描述：检查用户是否已收藏指定新闻

请求方式：GET

接口地址：/api/favorite/check

请求头：

参数名 类型 必填 描述
Authorization String 是 用户令牌

请求参数：

参数名 类型 必填 描述
newsId Number 是 新闻ID

响应参数：

1
2
3
4
5
6
7
{
  "code": 200,
  "message": "success",
  "data": {
    "isFavorite": true  
  }
}

5. 清空所有收藏

  • 接口地址: DELETE /api/favorite/clear
  • 请求头: 需要认证
  • 响应示例:
1
2
3
4
5
{
  "code": 200,
  "message": "成功删除1条收藏记录",
  "data": null
}