docs: 添加点赞功能相关API文档
- 在admin.md中添加点赞管理相关接口说明 - 在frontend-config.md中新增customCssUrl配置项 - 新增admin/stats.md详细描述点赞统计和记录接口 - 在public.md中添加获取点赞状态和点赞操作接口
This commit is contained in:
@@ -136,3 +136,124 @@ GET /admin/stats/domains
|
||||
"message": "获取域名列表失败"
|
||||
}
|
||||
```
|
||||
|
||||
## 1.3 获取点赞统计数据(点赞排行榜)
|
||||
|
||||
```
|
||||
GET /admin/likes/stats
|
||||
```
|
||||
|
||||
用于管理后台展示按点赞数排序的页面列表,例如「点赞排行榜」。
|
||||
|
||||
- 方法:`GET`
|
||||
- 路径:`/admin/likes/stats`
|
||||
- 鉴权:需要(Bearer Token)
|
||||
|
||||
当前实现不接收查询参数,默认返回点赞数最多的前 50 条记录。
|
||||
|
||||
**成功响应**
|
||||
|
||||
- 状态码:`200`
|
||||
|
||||
```json
|
||||
{
|
||||
"items": [
|
||||
{
|
||||
"pageSlug": "https://example.com/blog/hello-world",
|
||||
"pageTitle": "Hello World",
|
||||
"pageUrl": "https://example.com/blog/hello-world",
|
||||
"likes": 12
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
字段说明:
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
| ------------ | ------ | ---------------------------- |
|
||||
| `pageSlug` | string | 页面唯一标识符 |
|
||||
| `pageTitle` | string \| null | 页面标题 |
|
||||
| `pageUrl` | string \| null | 页面 URL |
|
||||
| `likes` | number | 当前页面累计点赞数 |
|
||||
|
||||
**错误响应**
|
||||
|
||||
- 状态码:`500`
|
||||
|
||||
```json
|
||||
{
|
||||
"message": "获取点赞统计失败"
|
||||
}
|
||||
```
|
||||
|
||||
## 1.4 获取点赞记录列表
|
||||
|
||||
```
|
||||
GET /admin/likes/list
|
||||
```
|
||||
|
||||
用于管理后台查看单条点赞记录列表,支持按页面、用户以及时间范围筛选。
|
||||
|
||||
- 方法:`GET`
|
||||
- 路径:`/admin/likes/list`
|
||||
- 鉴权:需要(Bearer Token)
|
||||
|
||||
**查询参数**
|
||||
|
||||
| 名称 | 位置 | 类型 | 必填 | 说明 |
|
||||
| ----------- | ----- | ------- | ---- | --------------------------------------------------- |
|
||||
| `page` | query | integer | 否 | 页码,默认 `1` |
|
||||
| `page_slug` | query | string | 否 | 按页面标识筛选点赞记录 |
|
||||
| `user_id` | query | string | 否 | 按用户标识筛选点赞记录,对应前端的 `X-CWD-Like-User` |
|
||||
| `start` | query | number | 否 | 起始时间(毫秒时间戳),大于等于该时间的记录 |
|
||||
| `end` | query | number | 否 | 结束时间(毫秒时间戳),小于等于该时间的记录 |
|
||||
|
||||
说明:
|
||||
|
||||
- 当前实现中每页固定大小为 `20`;
|
||||
- 既可以使用 `page_slug` / `user_id`,也可以同时使用两者进行组合筛选。
|
||||
|
||||
**成功响应**
|
||||
|
||||
- 状态码:`200`
|
||||
|
||||
```json
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"id": 1,
|
||||
"pageSlug": "https://example.com/blog/hello-world",
|
||||
"userId": "550e8400-e29b-41d4-a716-446655440000",
|
||||
"createdAt": 1737593600000
|
||||
}
|
||||
],
|
||||
"pagination": {
|
||||
"page": 1,
|
||||
"limit": 20,
|
||||
"total": 3
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
字段说明:
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
| -------------------- | ------ | ---------------------------- |
|
||||
| `data[].id` | number | 点赞记录 ID |
|
||||
| `data[].pageSlug` | string | 页面唯一标识符 |
|
||||
| `data[].userId` | string | 用户标识(来自 `X-CWD-Like-User` 或 IP) |
|
||||
| `data[].createdAt` | number | 点赞时间戳(毫秒) |
|
||||
| `pagination.page` | number | 当前页码 |
|
||||
| `pagination.limit` | number | 每页数量(固定为 20) |
|
||||
| `pagination.total` | number | 总页数 |
|
||||
|
||||
**错误响应**
|
||||
|
||||
- 状态码:`500`
|
||||
|
||||
```json
|
||||
{
|
||||
"message": "获取点赞记录失败"
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user