chore: 修改前端小组件结构
This commit is contained in:
@@ -12,7 +12,7 @@
|
||||
- 路径:`/api/comments`
|
||||
- 鉴权:不需要
|
||||
|
||||
### 查询参数
|
||||
**查询参数**
|
||||
|
||||
| 名称 | 位置 | 类型 | 必填 | 说明 |
|
||||
| --------------- | ----- | ------- | ---- | --------------------------------------------------- |
|
||||
@@ -21,7 +21,7 @@
|
||||
| `limit` | query | integer | 否 | 每页数量,默认 `20`,最大 `50` |
|
||||
| `nested` | query | string | 否 | 是否返回嵌套结构,默认 `'true'` |
|
||||
|
||||
### 成功响应
|
||||
**成功响应**
|
||||
|
||||
- 状态码:`200`
|
||||
|
||||
@@ -69,7 +69,7 @@
|
||||
- 当 `nested=true`(默认)时,接口返回的是“根评论列表”,每条根评论包含其 `replies`。
|
||||
- 当 `nested=false` 时,接口返回扁平列表,所有评论都在 `data` 中,`replies` 为空。
|
||||
|
||||
### 错误响应
|
||||
**错误响应**
|
||||
|
||||
- 缺少 `post_slug`:
|
||||
|
||||
@@ -99,13 +99,13 @@
|
||||
- 路径:`/api/comments`
|
||||
- 鉴权:不需要
|
||||
|
||||
### 请求头
|
||||
**请求头**
|
||||
|
||||
| 名称 | 必填 | 示例 |
|
||||
| -------------- | ---- | ---------------------------- |
|
||||
| `Content-Type` | 是 | `application/json` |
|
||||
|
||||
### 请求体(Request Body)
|
||||
**请求体(Request Body)**
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -120,7 +120,7 @@
|
||||
}
|
||||
```
|
||||
|
||||
#### 字段说明
|
||||
**字段说明**
|
||||
|
||||
| 字段名 | 类型 | 必填 | 说明 |
|
||||
| ------------ | ------ | ---- | ------------------------------------------------------------------------------------------------------------- |
|
||||
@@ -133,7 +133,7 @@
|
||||
| `content` | string | 是 | 评论内容,内部会过滤 `<script>...</script>` 片段 |
|
||||
| `parent_id` | number | 否 | 父评论 ID,用于回复功能;缺省或 `null` 表示根评论 |
|
||||
|
||||
### 成功响应
|
||||
**成功响应**
|
||||
|
||||
- 状态码:`200`
|
||||
|
||||
@@ -145,7 +145,7 @@
|
||||
|
||||
当前实现中评论会直接以 `approved` 状态写入数据库,后续如引入人工审核可在实现中调整为“待审核”状态。
|
||||
|
||||
### 错误响应与限流
|
||||
**错误响应**与限流
|
||||
|
||||
- 请求体缺失或字段类型错误:
|
||||
|
||||
@@ -206,7 +206,7 @@
|
||||
|
||||
```json
|
||||
{
|
||||
"message": "评论频繁,等10s后再试"
|
||||
"message": "评论频繁,等 10s 后再试"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -228,7 +228,7 @@
|
||||
- 路径:`/api/config/comments`
|
||||
- 鉴权:不需要
|
||||
|
||||
### 成功响应
|
||||
**成功响应**
|
||||
|
||||
- 状态码:`200`
|
||||
|
||||
@@ -254,7 +254,7 @@
|
||||
| `allowedDomains` | Array\<string\> | 允许调用组件的域名列表,留空则不限制 |
|
||||
| `requireReview` | boolean | 是否开启新评论先审核再显示(true 表示新评论默认为待审核) |
|
||||
|
||||
### 错误响应
|
||||
**错误响应**
|
||||
|
||||
- 状态码:`500`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user