docs: 更新API文档结构并完善功能说明
- 重构API文档侧边栏,将公开API拆分为子分类(评论、点赞、配置、身份验证、访问统计) - 新增详细的公开API接口文档,包括评论管理、点赞功能、配置获取、身份验证和访问统计 - 完善数据统计功能文档,增加概览数据、访问明细和数据分析说明 - 更新功能设置文档,补充图片预览和个性化设置说明 - 修正管理员登录文档中的错误描述和格式问题
This commit is contained in:
@@ -14,7 +14,7 @@ Authorization: Bearer <token>
|
||||
GET /admin/analytics/overview
|
||||
```
|
||||
|
||||
用于管理后台「访问统计」页面展示整体访问数据,包括总 PV、总页面数以及最近 30 天的访问趋势。
|
||||
用于管理后台「访问统计」页面展示整体访问数据,包括总 PV、总页面数、今日/昨日/本周/上周/本月/上月访问量以及最近 30 天的访问趋势。
|
||||
|
||||
- 方法:`GET`
|
||||
- 路径:`/admin/analytics/overview`
|
||||
@@ -34,6 +34,12 @@ GET /admin/analytics/overview
|
||||
{
|
||||
"totalPv": 1000,
|
||||
"totalPages": 50,
|
||||
"todayPv": 100,
|
||||
"yesterdayPv": 80,
|
||||
"weekPv": 500,
|
||||
"lastWeekPv": 400,
|
||||
"monthPv": 800,
|
||||
"lastMonthPv": 650,
|
||||
"last30Days": [
|
||||
{
|
||||
"date": "2026-01-15",
|
||||
@@ -53,10 +59,23 @@ GET /admin/analytics/overview
|
||||
| -------------- | ------------------- | ------------------------------------- |
|
||||
| `totalPv` | number | 总访问量(PV) |
|
||||
| `totalPages` | number | 总页面数 |
|
||||
| `todayPv` | number | 今日访问量 |
|
||||
| `yesterdayPv` | number | 昨日访问量 |
|
||||
| `weekPv` | number | 本周访问量 |
|
||||
| `lastWeekPv` | number | 上周访问量(用于同比对比) |
|
||||
| `monthPv` | number | 本月访问量 |
|
||||
| `lastMonthPv` | number | 上月访问量(用于同比对比) |
|
||||
| `last30Days` | Array\<DailyStat\> | 最近 30 天的每日访问数(按自然日聚合) |
|
||||
| `last30Days[].date` | string (YYYY-MM-DD) | 日期,UTC 时间格式化后的自然日 |
|
||||
| `last30Days[].total` | number | 当日访问总数 |
|
||||
|
||||
**说明**:
|
||||
|
||||
- `weekPv`:本周(从周一到当天)的总访问量
|
||||
- `lastWeekPv`:上周(上周一到上周日)的总访问量,用于与本周进行同比对比
|
||||
- `monthPv`:本月(从本月1号到当天)的总访问量
|
||||
- `lastMonthPv`:上月(上月1号到上月最后一天)的总访问量,用于与本月进行进行同比对比
|
||||
|
||||
**错误响应**
|
||||
|
||||
- 状态码:`500`
|
||||
|
||||
@@ -69,7 +69,7 @@ POST /admin/login
|
||||
|
||||
| 参数 | 值 | 说明 |
|
||||
|------|-----|------|
|
||||
| 最大失败次数 | 5 次 | 超过次数后封禁 IP |
|
||||
| 最大失败次数 | 5.次 | 超过次数后封禁 IP |
|
||||
| 封禁时间 | 30 分钟 | IP 被封禁后需等待此时间 |
|
||||
| 计数有效期 | 10 分钟 | 失败计数在此时间后自动重置 |
|
||||
|
||||
@@ -80,7 +80,7 @@ POST /admin/login
|
||||
4. 登录成功后会清除失败计数
|
||||
5. 所有状态存储在 Cloudflare KV 中,基于 IP 地址区分
|
||||
|
||||
- 登录失败(用户名或密码错误):
|
||||
- 登录失败(用户名或密码无效):
|
||||
- 状态码:`401`
|
||||
|
||||
```json
|
||||
@@ -92,7 +92,7 @@ POST /admin/login
|
||||
|
||||
`failedAttempts` 字段表示当前失败次数(1-4),前端可用于提示用户剩余尝试次数。
|
||||
|
||||
- 登录失败次数过多导致 IP 被封禁:
|
||||
- IP 已被封禁:
|
||||
- 状态码:`403`
|
||||
|
||||
```json
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# 功能设置相关
|
||||
|
||||
管理点赞功能开关的接口。
|
||||
管理各项功能开关的接口,包括点赞功能、图片灯箱预览、评论占位符、域名可见性等。
|
||||
|
||||
## 获取功能设置
|
||||
|
||||
@@ -21,16 +21,22 @@ GET /admin/settings/feature
|
||||
```json
|
||||
{
|
||||
"enableCommentLike": true,
|
||||
"enableArticleLike": true
|
||||
"enableArticleLike": true,
|
||||
"enableImageLightbox": true,
|
||||
"commentPlaceholder": "发表你的看法...",
|
||||
"visibleDomains": ["example.com", "blog.example.com"]
|
||||
}
|
||||
```
|
||||
|
||||
字段说明:
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
| ------------------ | ------- | ---------------------- |
|
||||
| `enableCommentLike` | boolean | 是否启用评论点赞功能 |
|
||||
| `enableArticleLike` | boolean | 是否启用文章点赞功能 |
|
||||
| 字段名 | 类型 | 说明 |
|
||||
| -------------------- | ------ | ---------------------- |
|
||||
| `enableCommentLike` | boolean | 是否启用评论点赞功能 |
|
||||
| `enableArticleLike` | boolean | 是否启用文章点赞功能 |
|
||||
| `enableImageLightbox` | boolean | 是否启用评论图片灯箱预览功能 |
|
||||
| `commentPlaceholder` | string \| null | 评论输入框的占位符文本 |
|
||||
| `visibleDomains` | string[] | 允许显示评论组件的域名列表 |
|
||||
|
||||
## 更新功能设置
|
||||
|
||||
@@ -56,16 +62,28 @@ PUT /admin/settings/feature
|
||||
```json
|
||||
{
|
||||
"enableCommentLike": true,
|
||||
"enableArticleLike": true
|
||||
"enableArticleLike": true,
|
||||
"enableImageLightbox": true,
|
||||
"commentPlaceholder": "发表你的看法...",
|
||||
"visibleDomains": ["example.com", "blog.example.com"]
|
||||
}
|
||||
```
|
||||
|
||||
字段说明:
|
||||
|
||||
| 字段名 | 类型 | 必填 | 说明 |
|
||||
| ------------------ | ------- | ---- | ---------------------- |
|
||||
| `enableCommentLike` | boolean | 否 | 是否启用评论点赞功能 |
|
||||
| `enableArticleLike` | boolean | 否 | 是否启用文章点赞功能 |
|
||||
| 字段名 | 类型 | 必填 | 说明 |
|
||||
| -------------------- | ------- | ---- | ---------------------- |
|
||||
| `enableCommentLike` | boolean | 否 | 是否启用评论点赞功能 |
|
||||
| `enableArticleLike` | boolean | 否 | 是否启用文章点赞功能 |
|
||||
| `enableImageLightbox` | boolean | 否 | 是否启用评论图片灯箱预览功能 |
|
||||
| `commentPlaceholder` | string | 否 | 评论输入框的占位符文本 |
|
||||
| `visibleDomains` | string[] | 否 | 允许显示评论组件的域名列表 |
|
||||
|
||||
**说明**:
|
||||
|
||||
- `enableImageLightbox`:启用后,评论内容中的图片可以点击放大预览
|
||||
- `commentPlaceholder`:自定义评论输入框的占位符文本,留空则使用默认文本
|
||||
- `visibleDomains`:设置后,只有在此列表中的域名可以正常显示评论组件,其他域名将被隐藏。留空或为 `null` 表示不限制域名。
|
||||
|
||||
**成功响应**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user