0a7dca07ed
修改page_visit_daily表的created_at和updated_at字段类型，从TEXT改为INTEGER 同时更新相关插入和更新操作，使用时间戳而非ISO格式字符串
494 lines
11 KiB
Markdown
494 lines
11 KiB
Markdown
# 公开 API 相关
|
||
|
||
无需认证即可访问的公开接口，包括评论获取、评论提交、配置获取和身份验证。
|
||
|
||
包含路径、方法、参数、请求体和响应示例。
|
||
|
||
## 1. 评论相关
|
||
|
||
### 1.1 获取指定文章的评论列表
|
||
|
||
```
|
||
GET /api/comments
|
||
```
|
||
|
||
获取指定文章的评论列表，支持分页和嵌套结构。
|
||
|
||
- 方法：`GET`
|
||
- 路径：`/api/comments`
|
||
- 鉴权：不需要
|
||
|
||
**查询参数**
|
||
|
||
| 名称 | 位置 | 类型 | 必填 | 说明 |
|
||
| --------------- | ----- | ------- | ---- | --------------------------------------------------- |
|
||
| `post_slug` | query | string | 是 | `window.location.origin + window.location.pathname` |
|
||
| `page` | query | integer | 否 | 页码，默认 `1` |
|
||
| `limit` | query | integer | 否 | 每页数量，默认 `20`，最大 `50` |
|
||
| `nested` | query | string | 否 | 是否返回嵌套结构，默认 `'true'` |
|
||
|
||
**成功响应**
|
||
|
||
- 状态码：`200`
|
||
|
||
```json
|
||
{
|
||
"data": [
|
||
{
|
||
"id": 1,
|
||
"author": "张三",
|
||
"email": "zhangsan@example.com",
|
||
"url": "https://example.com",
|
||
"contentText": "很棒的文章！",
|
||
"contentHtml": "很棒的文章！",
|
||
"pubDate": "2026-01-13T10:00:00Z",
|
||
"postSlug": "/blog/hello-world",
|
||
"avatar": "https://gravatar.com/avatar/...",
|
||
"priority": 2,
|
||
"replies": [
|
||
{
|
||
"id": 2,
|
||
"author": "李四",
|
||
"email": "lisi@example.com",
|
||
"url": null,
|
||
"contentText": "同感！",
|
||
"contentHtml": "同感！",
|
||
"pubDate": "2026-01-13T11:00:00Z",
|
||
"postSlug": "/blog/hello-world",
|
||
"avatar": "https://gravatar.com/avatar/...",
|
||
"parentId": 1,
|
||
"replyToAuthor": "张三",
|
||
"priority": 1
|
||
}
|
||
]
|
||
}
|
||
],
|
||
"pagination": {
|
||
"page": 1,
|
||
"limit": 20,
|
||
"total": 1,
|
||
"totalCount": 2
|
||
}
|
||
}
|
||
```
|
||
|
||
说明：
|
||
|
||
- 当 `nested=true`（默认）时，接口返回的是"根评论列表"，每条根评论包含其 `replies`。
|
||
- 当 `nested=false` 时，接口返回扁平列表，所有评论都在 `data` 中，`replies` 为空。
|
||
- `priority` 字段：评论的置顶权重，数值越大排序越靠前。
|
||
|
||
**错误响应**
|
||
|
||
- 缺少 `post_slug`：
|
||
|
||
- 状态码：`400`
|
||
|
||
```json
|
||
{
|
||
"message": "post_slug is required"
|
||
}
|
||
```
|
||
|
||
- 服务器内部错误：
|
||
|
||
- 状态码：`500`
|
||
|
||
```json
|
||
{
|
||
"message": "错误信息"
|
||
}
|
||
```
|
||
|
||
### 1.2 提交新评论或回复
|
||
|
||
```
|
||
POST /api/comments
|
||
```
|
||
|
||
提交新评论或回复。
|
||
|
||
- 方法：`POST`
|
||
- 路径：`/api/comments`
|
||
- 鉴权：不需要
|
||
|
||
**请求头**
|
||
|
||
| 名称 | 必填 | 示例 |
|
||
| -------------- | ---- | ---------------------------- |
|
||
| `Content-Type` | 是 | `application/json` |
|
||
|
||
**请求体（Request Body）**
|
||
|
||
```json
|
||
{
|
||
"post_slug": "https://example.com/blog/hello-world",
|
||
"post_title": "博客标题，可选",
|
||
"post_url": "https://example.com/blog/hello-world",
|
||
"name": "张三",
|
||
"email": "zhangsan@example.com",
|
||
"url": "https://zhangsan.me",
|
||
"content": "很棒的文章！",
|
||
"parent_id": 1,
|
||
"adminToken": "your-admin-key"
|
||
}
|
||
```
|
||
|
||
字段说明：
|
||
|
||
| 字段名 | 类型 | 必填 | 说明 |
|
||
| ------------ | ------ | ---- | ------------------------------------------------------------------------------------------------------------- |
|
||
| `post_slug` | string | 是 | 文章唯一标识符，应与前端组件初始化时的 `postSlug` 值一致，`window.location.origin + window.location.pathname` |
|
||
| `post_title` | string | 否 | 文章标题，用于邮件通知内容 |
|
||
| `post_url` | string | 否 | 文章 URL，用于邮件通知中的跳转链接 |
|
||
| `name` | string | 是 | 评论者昵称 |
|
||
| `email` | string | 是 | 评论者邮箱，需为合法邮箱格式 |
|
||
| `url` | string | 否 | 评论者个人主页或站点地址 |
|
||
| `content` | string | 是 | 评论内容，内部会过滤 `<script>...</script>` 片段 |
|
||
| `parent_id` | number | 否 | 父评论 ID，用于回复功能；缺省或 `null` 表示根评论 |
|
||
| `adminToken` | string | 否 | 管理员评论密钥，博主发布评论时需要先通过 `/api/verify-admin` 验证密钥后将密钥传入此字段，评论将直接通过且不受审核设置影响 |
|
||
|
||
**成功响应**
|
||
|
||
- 状态码：`200`
|
||
|
||
评论直接通过时：
|
||
|
||
```json
|
||
{
|
||
"message": "评论已提交",
|
||
"status": "approved"
|
||
}
|
||
```
|
||
|
||
评论进入待审核状态时（开启"先审核再显示"且非管理员评论）：
|
||
|
||
```json
|
||
{
|
||
"message": "已提交评论，待管理员审核后显示",
|
||
"status": "pending"
|
||
}
|
||
```
|
||
|
||
**错误响应**
|
||
|
||
- 请求体缺失或字段类型错误：
|
||
|
||
- 状态码：`400`
|
||
|
||
```json
|
||
{
|
||
"message": "无效的请求体"
|
||
}
|
||
```
|
||
|
||
- 缺少必填字段：
|
||
|
||
- `post_slug` 为空：
|
||
|
||
```json
|
||
{
|
||
"message": "post_slug 必填"
|
||
}
|
||
```
|
||
|
||
- `content` 为空：
|
||
|
||
```json
|
||
{
|
||
"message": "评论内容不能为空"
|
||
}
|
||
```
|
||
|
||
- `author` 为空：
|
||
|
||
```json
|
||
{
|
||
"message": "昵称不能为空"
|
||
}
|
||
```
|
||
|
||
- `email` 为空或格式不正确：
|
||
|
||
```json
|
||
{
|
||
"message": "邮箱不能为空"
|
||
}
|
||
```
|
||
|
||
或
|
||
|
||
```json
|
||
{
|
||
"message": "邮箱格式不正确"
|
||
}
|
||
```
|
||
|
||
- IP 或邮箱被限制：
|
||
|
||
- IP 被限制：
|
||
- 状态码：`403`
|
||
|
||
```json
|
||
{
|
||
"message": "当前 IP 已被限制评论，请联系站长进行处理"
|
||
}
|
||
```
|
||
|
||
- 邮箱被限制：
|
||
- 状态码：`403`
|
||
|
||
```json
|
||
{
|
||
"message": "当前邮箱已被限制评论，请联系站长进行处理"
|
||
}
|
||
```
|
||
|
||
- 管理员评论验证失败：
|
||
|
||
- 未输入密钥：
|
||
- 状态码：`401`
|
||
|
||
```json
|
||
{
|
||
"message": "请输入管理员密钥",
|
||
"requireAuth": true
|
||
}
|
||
```
|
||
|
||
- 密钥错误：
|
||
- 状态码：`401`
|
||
|
||
```json
|
||
{
|
||
"message": "密钥错误"
|
||
}
|
||
```
|
||
|
||
- 验证失败次数过多：
|
||
- 状态码：`403`
|
||
|
||
```json
|
||
{
|
||
"message": "验证失败次数过多，请 30 分钟后再试"
|
||
}
|
||
```
|
||
|
||
- 评论频率限制：
|
||
|
||
- 状态码：`429`
|
||
- 逻辑：同一 IP 最近一条评论时间在 10 秒内，则拒绝此次请求。
|
||
|
||
```json
|
||
{
|
||
"message": "评论频繁，等 10s 后再试"
|
||
}
|
||
```
|
||
|
||
- 服务器内部错误：
|
||
|
||
- 状态码：`500`
|
||
|
||
```json
|
||
{
|
||
"message": "Internal Server Error"
|
||
}
|
||
```
|
||
|
||
## 2. 配置相关
|
||
|
||
### 2.1 获取评论相关的公开配置
|
||
|
||
```
|
||
GET /api/config/comments
|
||
```
|
||
|
||
获取评论相关的公开配置，用于前端组件读取博主邮箱、徽标等信息。
|
||
|
||
- 方法：`GET`
|
||
- 路径：`/api/config/comments`
|
||
- 鉴权：不需要
|
||
|
||
**成功响应**
|
||
|
||
- 状态码：`200`
|
||
|
||
```json
|
||
{
|
||
"adminEmail": "admin@example.com",
|
||
"adminBadge": "博主",
|
||
"avatar": "https://gravatar.com/avatar",
|
||
"adminEnabled": true,
|
||
"allowedDomains": [],
|
||
"requireReview": false
|
||
}
|
||
```
|
||
|
||
字段说明：
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
| -------------- | ------- | -------------------------------------------------------------------- |
|
||
| `adminEmail` | string | 博主邮箱地址，用于在前端展示"博主"标识，并触发管理员身份验证流程 |
|
||
| `adminBadge` | string | 博主标识文字，例如 `"博主"` |
|
||
| `avatarPrefix` | string | 头像地址前缀，如 Gravatar 或 Cravatar 镜像地址 |
|
||
| `adminEnabled` | boolean | 是否启用博主标识相关展示（关闭时不显示徽标，但仍可作为管理员邮箱） |
|
||
| `allowedDomains` | Array\<string\> | 允许调用组件的域名列表，留空则不限制 |
|
||
| `requireReview` | boolean | 是否开启新评论先审核再显示（true 表示新评论默认为待审核） |
|
||
|
||
**错误响应**
|
||
|
||
- 状态码：`500`
|
||
|
||
```json
|
||
{
|
||
"message": "加载评论配置失败"
|
||
}
|
||
```
|
||
|
||
## 3. 身份验证相关
|
||
|
||
### 3.1 验证管理员密钥
|
||
|
||
```
|
||
POST /api/verify-admin
|
||
```
|
||
|
||
验证前台管理员评论所需的密钥，用于博主发布评论时的身份验证。
|
||
|
||
- 方法：`POST`
|
||
- 路径：`/api/verify-admin`
|
||
- 鉴权：不需要
|
||
|
||
**请求头**
|
||
|
||
| 名称 | 必填 | 示例 |
|
||
| -------------- | ---- | ------------------ |
|
||
| `Content-Type` | 是 | `application/json` |
|
||
|
||
**请求体**
|
||
|
||
```json
|
||
{
|
||
"adminToken": "your-admin-key"
|
||
}
|
||
```
|
||
|
||
字段说明：
|
||
|
||
| 字段名 | 类型 | 必填 | 说明 |
|
||
| ----------- | ------ | ---- | -------------- |
|
||
| `adminToken` | string | 是 | 管理员评论密钥 |
|
||
|
||
**风控说明**
|
||
|
||
- 同一 IP 连续验证失败 3 次后，该 IP 将被锁定 30 分钟
|
||
- 失败次数记录有效期为 1 小时
|
||
|
||
**成功响应**
|
||
|
||
- 状态码：`200`
|
||
|
||
```json
|
||
{
|
||
"message": "验证通过"
|
||
}
|
||
```
|
||
|
||
或未设置密钥时：
|
||
|
||
```json
|
||
{
|
||
"message": "未设置管理员密钥"
|
||
}
|
||
```
|
||
|
||
**错误响应**
|
||
|
||
- 寽钥错误：
|
||
- 状态码：`401`
|
||
|
||
```json
|
||
{
|
||
"message": "密钥错误"
|
||
}
|
||
```
|
||
|
||
- 验证失败次数过多：
|
||
- 状态码：`403`
|
||
|
||
```json
|
||
{
|
||
"message": "验证失败次数过多，请 30 分钟后再试"
|
||
}
|
||
```
|
||
|
||
## 4. 访问统计相关
|
||
|
||
### 4.1 记录页面访问
|
||
|
||
```
|
||
POST /api/analytics/visit
|
||
```
|
||
|
||
前端组件在加载时调用此接口，记录页面访问数据，用于后台访问统计分析。
|
||
|
||
- 方法：`POST`
|
||
- 路径：`/api/analytics/visit`
|
||
- 鉴权：不需要
|
||
|
||
**请求头**
|
||
|
||
| 名称 | 必填 | 示例 |
|
||
| -------------- | ---- | ------------------ |
|
||
| `Content-Type` | 是 | `application/json` |
|
||
|
||
**请求体**
|
||
|
||
```json
|
||
{
|
||
"postSlug": "https://example.com/blog/hello-world",
|
||
"postTitle": "博客标题",
|
||
"postUrl": "https://example.com/blog/hello-world"
|
||
}
|
||
```
|
||
|
||
字段说明：
|
||
|
||
| 字段名 | 类型 | 必填 | 说明 |
|
||
| ----------- | ------ | ---- | -------------------------------------------------------------------- |
|
||
| `postSlug` | string | 是 | 文章唯一标识符，`window.location.origin + window.location.pathname` |
|
||
| `postTitle` | string | 否 | 文章标题，用于后台展示页面名称 |
|
||
| `postUrl` | string | 否 | 文章 URL，用于后台展示页面链接和域名统计 |
|
||
|
||
**成功响应**
|
||
|
||
- 状态码：`200`
|
||
|
||
```json
|
||
{
|
||
"success": true
|
||
}
|
||
```
|
||
|
||
**错误响应**
|
||
|
||
- 缺少 `postSlug`：
|
||
|
||
- 状态码：`400`
|
||
|
||
```json
|
||
{
|
||
"message": "postSlug is required"
|
||
}
|
||
```
|
||
|
||
- 服务器内部错误：
|
||
|
||
- 状态码：`500`
|
||
|
||
```json
|
||
{
|
||
"message": "记录访问数据失败"
|
||
}
|
||
```
|