荣誉模块
控制层 TypechoHonorController @author honor @date 2025/10/17
类路径:HonorController
前缀:/honor
1. add
接口路径:GET/POST /honor/add
权限:需要超级管理员权限
接口说明:管理员添加荣誉 @param params Bean对象JSON字符串
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.honorAdd() (https://api.ruletree.club/honor/add)
2. edit
接口路径:GET/POST /honor/edit
权限:需要超级管理员权限
接口说明:修改荣誉
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.honorEdit() (https://api.ruletree.club/honor/edit)
3. delete
接口路径:GET/POST /honor/delete
权限:需要超级管理员权限
接口说明:删除荣誉
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| id | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.honorDelete() (https://api.ruletree.club/honor/delete)
4. awardedHonor
接口路径:GET/POST /honor/awardedHonor
权限:需要超级管理员权限
接口说明:管理员发放荣誉(支持days参数设置有效期)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| id | Integer | 否 | - | |
| uid | Integer | 否 | - | |
| days | Integer | 否 | 0 | |
| remark | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.awardedHonor() (https://api.ruletree.club/honor/awardedHonor)
5. honorList
接口路径:GET/POST /honor/honorList
权限:公开接口;但当系统配置 isLogin=1 时会强制要求登录
接口说明:荣誉列表
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| searchKey | String | 否 | - | |
| page | Integer | 否 | 1 | |
| order | String | 否 | created | |
| limit | Integer | 否 | 15 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.honorList() (https://api.ruletree.club/honor/honorList)
6. myHonor
接口路径:GET/POST /honor/myHonor
权限:需要登录(普通用户及以上)
接口说明:我的荣誉(用户查询发放给自己的荣誉)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 15 | |
| status | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.myHonor() (https://api.ruletree.club/honor/myHonor)
7. wearHonor
接口路径:GET/POST /honor/wearHonor
权限:需要登录(普通用户及以上)
接口说明:佩戴荣誉
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| logId | Integer | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.wearHonor() (https://api.ruletree.club/honor/wearHonor)
8. userHonor
接口路径:GET/POST /honor/userHonor
权限:公开接口;但当系统配置 isLogin=1 时会强制要求登录
接口说明:查询用户获得的荣誉(管理员查询指定uid的荣誉,支持未到期/已到期筛选)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| uid | Integer | 否 | - | |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 15 | |
| status | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.userHonor() (https://api.ruletree.club/honor/userHonor)
9. revokeHonor
接口路径:GET/POST /honor/revokeHonor
权限:需要超级管理员权限
接口说明:管理员撤销用户荣誉
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| logId | Integer | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
10. cancelWearHonor
接口路径:GET/POST /honor/cancelWearHonor
权限:需要登录(普通用户及以上)
接口说明:取消佩戴荣誉
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| type | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.wearHonor() (https://api.ruletree.club/honor/wearHonor)
- 前端调用:this.$API.cancelWearHonor() (https://api.ruletree.club/honor/cancelWearHonor)