评论模块
控制层 TypechoCommentsController @author buxia97 @date 2021/11/29
类路径:CommentsController
前缀:/typechoComments
1. commentsList
接口路径:GET/POST /typechoComments/commentsList
权限:公开接口;但当系统配置 isLogin=1 时会强制要求登录
接口说明:查询评论 @param searchParams Bean对象JSON字符串 @param page 页码 @param limit 每页显示数量
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| page | Integer | 否 | 1 | |
| searchKey | String | 否 | - | |
| order | String | 否 | created | |
| limit | Integer | 否 | 15 | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.getCommentsList() (https://api.ruletree.club/typechoComments/commentsList)
2. commentsAdd
接口路径:GET/POST /typechoComments/commentsAdd
权限:需要登录(普通用户及以上)
接口说明:添加评论 @param params Bean对象JSON字符串
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - | |
| text | String | 否 | - | |
| atUsers | String | 否 | - | |
| verifyCode | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.setComments() (https://api.ruletree.club/typechoComments/commentsAdd)
3. commentsEdit
接口路径:GET/POST /typechoComments/commentsEdit
权限:需要登录(普通用户及以上)
接口说明:编辑
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - | |
| text | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
4. Audit
接口路径:GET/POST /typechoComments/commentsAudit
权限:需要管理员或编辑权限
接口说明:评论审核
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| key | String | 否 | - | |
| token | String | 否 | - | |
| type | Integer | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.commentsAudit() (https://api.ruletree.club/typechoComments/commentsAudit)
5. commentsDelete
接口路径:GET/POST /typechoComments/commentsDelete
权限:需要登录(普通用户及以上)
接口说明:评论删除
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| key | String | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.commentsDelete() (https://api.ruletree.club/typechoComments/commentsDelete)
6. commentLikes
接口路径:GET/POST /typechoComments/commentLikes
权限:需要登录(普通用户及以上)
接口说明:评论点赞
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | Integer | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}