shumengya/cwd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: 修改前端小组件结构

Browse Source
This commit is contained in:
anghunk
2026-01-21 11:43:25 +08:00
parent a9c8f0b541
commit 75b434ccbd
29 changed files with 63 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
docs/api/admin.md
View File

@@ -18,13 +18,13 @@ Token 通过登录接口获取，有效期为 24 小时。
- 路径：`/admin/login`
- 鉴权：不需要
### 请求头
**请求头**
| 名称 | 必填 | 示例 |
| -------------- | ---- | ------------------ |
| `Content-Type` | 是 | `application/json` |
### 请求体
**请求体**
```json
{
@@ -45,7 +45,7 @@ Token 通过登录接口获取，有效期为 24 小时。
- `ADMIN_NAME`
- `ADMIN_PASSWORD`
### 成功响应
**成功响应**
- 状态码：`200`
@@ -59,7 +59,7 @@ Token 通过登录接口获取，有效期为 24 小时。
前端需要将 `data.key` 作为 Token 存储（例如 LocalStorage），并在后续请求中通过 `Authorization: Bearer <key>` 携带。
### 错误与风控
**错误与风控**
- 登录失败（用户名或密码错误）：
- 状态码：`401`
@@ -97,7 +97,7 @@ Token 通过登录接口获取，有效期为 24 小时。
- 路径：`/admin/comments/list`
- 鉴权：需要（Bearer Token）
### 查询参数
**查询参数**
| 名称 | 位置 | 类型 | 必填 | 说明 |
| ------ | ----- | ------- | ---- | -------------- |
@@ -107,7 +107,7 @@ Token 通过登录接口获取，有效期为 24 小时。
- 当前实现中每页固定大小为 `10`，暂不支持 `pageSize` 或状态过滤。
### 成功响应
**成功响应**
- 状态码：`200`
@@ -136,7 +136,7 @@ Token 通过登录接口获取，有效期为 24 小时。
}
```
### 鉴权错误
**鉴权错误**
- 未携带 Token 或 Token 失效：
- 状态码：`401`
@@ -155,7 +155,7 @@ Token 通过登录接口获取，有效期为 24 小时。
- 路径：`/admin/comments/status`
- 鉴权：需要（Bearer Token）
### 查询参数
**查询参数**
| 名称 | 位置 | 类型 | 必填 | 说明 |
| -------- | ----- | ------ | ---- | ------------------------------------- |
@@ -167,7 +167,7 @@ Token 通过登录接口获取，有效期为 24 小时。
- `approved`：已通过
- `rejected`：已拒绝
### 成功响应
**成功响应**
- 状态码：`200`
@@ -177,7 +177,7 @@ Token 通过登录接口获取，有效期为 24 小时。
}
```
### 错误响应
**错误响应**
- 缺少参数：
- 状态码：`400`
@@ -205,13 +205,13 @@ Token 通过登录接口获取，有效期为 24 小时。
- 路径：`/admin/comments/delete`
- 鉴权：需要（Bearer Token）
### 查询参数
**查询参数**
| 名称 | 位置 | 类型 | 必填 | 说明 |
| ---- | ----- | ------ | ---- | ------- |
| `id` | query | number | 是 | 评论 ID |
### 成功响应
**成功响应**
- 状态码：`200`
@@ -221,7 +221,7 @@ Token 通过登录接口获取，有效期为 24 小时。
}
```
### 错误响应
**错误响应**
- 缺少 ID：
- 状态码：`400`
@@ -249,7 +249,7 @@ Token 通过登录接口获取，有效期为 24 小时。
- 路径：`/admin/comments/export`
- 鉴权：需要（Bearer Token）
### 成功响应
**成功响应**
- 状态码：`200`
@@ -275,7 +275,7 @@ Token 通过登录接口获取，有效期为 24 小时。
]
```
### 错误响应
**错误响应**
- 导出失败：
- 状态码：`500`
@@ -294,7 +294,7 @@ Token 通过登录接口获取，有效期为 24 小时。
- 路径：`/admin/comments/import`
- 鉴权：需要（Bearer Token）
### 请求体
**请求体**
```json
[
@@ -320,7 +320,7 @@ Token 通过登录接口获取，有效期为 24 小时。
字段说明：与导出格式一致。如果不提供 `id`，则会自动生成。
### 成功响应
**成功响应**
- 状态码：`200`
@@ -330,7 +330,7 @@ Token 通过登录接口获取，有效期为 24 小时。
}
```
### 错误响应
**错误响应**
- 导入数据为空：
- 状态码：`400`
@@ -358,7 +358,7 @@ Token 通过登录接口获取，有效期为 24 小时。
- 路径：`/admin/settings/email`
- 鉴权：需要（Bearer Token）
### 成功响应
**成功响应**
- 状态码：`200`
@@ -368,7 +368,7 @@ Token 通过登录接口获取，有效期为 24 小时。
}
```
### 错误响应
**错误响应**
- 状态码：`500`
@@ -386,13 +386,13 @@ Token 通过登录接口获取，有效期为 24 小时。
- 路径：`/admin/settings/email`
- 鉴权：需要（Bearer Token）
### 请求头
**请求头**
| 名称 | 必填 | 示例 |
| -------------- | ---- | ------------------ |
| `Content-Type` | 是 | `application/json` |
### 请求体
**请求体**
```json
{
@@ -400,7 +400,7 @@ Token 通过登录接口获取，有效期为 24 小时。
}
```
### 成功响应
**成功响应**
- 状态码：`200`
@@ -410,7 +410,7 @@ Token 通过登录接口获取，有效期为 24 小时。
}
```
### 错误响应
**错误响应**
- 邮箱格式不正确：
- 状态码：`400`
@@ -438,7 +438,7 @@ Token 通过登录接口获取，有效期为 24 小时。
- 路径：`/admin/settings/comments`
- 鉴权：需要（Bearer Token）
### 成功响应
**成功响应**
- 状态码：`200`
@@ -468,7 +468,7 @@ Token 通过登录接口获取，有效期为 24 小时。
| `adminKeySet` | boolean | 是否已经设置过管理员评论密钥 |
| `requireReview` | boolean | 是否开启新评论先审核再显示（true 表示新评论默认为待审核） |
### 错误响应
**错误响应**
- 状态码：`500`
@@ -486,13 +486,13 @@ Token 通过登录接口获取，有效期为 24 小时。
- 路径：`/admin/settings/comments`
- 鉴权：需要（Bearer Token）
### 请求头
**请求头**
| 名称 | 必填 | 示例 |
| -------------- | ---- | ------------------ |
| `Content-Type` | 是 | `application/json` |
### 请求体
**请求体**
```json
{
@@ -518,7 +518,7 @@ Token 通过登录接口获取，有效期为 24 小时。
| `adminKey` | string | 否 | 管理员评论密钥，留空则表示清除密钥；设置后前台管理员评论需输入密钥 |
| `requireReview` | boolean | 否 | 是否开启新评论先审核再显示（不传则保持不变） |
### 成功响应
**成功响应**
- 状态码：`200`
@@ -528,7 +528,7 @@ Token 通过登录接口获取，有效期为 24 小时。
}
```
### 错误响应
**错误响应**
- 邮箱格式错误：
- 状态码：`400`