关注系统模块
文档所属项目:花枫咖啡馆Internal API文档 (/wiki/flowermaplechatapi)
花枫咖啡馆内部扩展 API — 关注系统模块 (Follow)
基础信息
- 前缀URL:
/v1/internal - 主要功能: 关注/取消关注用户、查询关注列表与粉丝列表、统计关注/粉丝数、判断关注状态。
接口列表
1. 关注用户
POST /v1/internal/follow.add
关注目标用户。需 Header 携带 Token。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| following_id | number | 是 | 要关注的目标用户 ID |
请求示例
{
"following_id": 2
}
成功响应示例
{
"success": true,
"data": { "id": 10 }
}
2. 取消关注
POST /v1/internal/follow.remove
取消对目标用户的关注。需 Header 携带 Token。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| following_id | number | 是 | 目标用户 ID |
请求示例
{
"following_id": 2
}
成功响应示例
{
"success": true,
"data": 1
}
3. 获取关注列表
POST /v1/internal/follow.list
获取指定用户正在关注的人员列表。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| user_id | number | 否 | 目标用户 ID(默认当前登录用户) |
| page | number | 否 | 页码,默认 1 |
| limit | number | 否 | 每页数量,默认 10 |
请求示例
{
"user_id": 1,
"page": 1,
"limit": 10
}
成功响应示例
{
"data": [
{
"id": 2,
"username": "lisi",
"avatar_url": "https://example.com/avatar2.jpg"
}
]
}
4. 获取粉丝列表
POST /v1/internal/followers.list
获取关注指定用户的粉丝列表。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| user_id | number | 否 | 目标用户 ID(默认当前登录用户) |
| page | number | 否 | 页码,默认 1 |
| limit | number | 否 | 每页数量,默认 10 |
请求示例
{
"user_id": 1,
"page": 1,
"limit": 10
}
成功响应示例
{
"data": [
{
"id": 3,
"username": "wangwu",
"avatar_url": "https://example.com/avatar3.jpg"
}
]
}
5. 获取关注与粉丝计数
POST /v1/internal/follow.counts
获取用户的关注总数和粉丝总数。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| user_id | number | 否 | 目标用户 ID(默认当前登录用户) |
请求示例
{
"user_id": 1
}
成功响应示例
{
"following_count": 12,
"follower_count": 45
}
6. 检查关注状态
POST /v1/internal/follow.check
查询当前登录用户是否已关注指定用户。需 Header 携带 Token。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| user_id | number | 是 | 检查的目标用户 ID |
请求示例
{
"user_id": 2
}
成功响应示例
{
"is_following": true
}
