分类标签模块
控制层 TypechoMetasController @author buxia97 @date 2021/11/29
类路径:MetasController
前缀:/typechoMetas
1. selectContents
接口路径:GET/POST /typechoMetas/selectContents
权限:公开接口;但当系统配置 isLogin=1 时会强制要求登录
接口说明:查询分类或标签下的文章
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| page | Integer | 否 | 1 | |
| searchKey | String | 否 | - | |
| limit | Integer | 否 | 15 | |
| order | String | 否 | created | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.getMetaContents() (https://api.ruletree.club/typechoMetas/selectContents)
2. metasList
接口路径:GET/POST /typechoMetas/metasList
权限:公开接口;但当系统配置 isLogin=1 时会强制要求登录
接口说明:查询分类和标签 @param searchParams Bean对象JSON字符串 @param page 页码 @param limit 每页显示数量
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 15 | |
| searchKey | String | 否 | - | |
| order | String | 否 | order |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.getMetasList() (https://api.ruletree.club/typechoMetas/metasList)
3. metaInfo
接口路径:GET/POST /typechoMetas/metaInfo
权限:公开接口,不校验 token
接口说明:查询分类详情
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| key | String | 否 | - | |
| slug | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.geMetaInfo() (https://api.ruletree.club/typechoMetas/metaInfo)
4. editMeta
接口路径:GET/POST /typechoMetas/editMeta
权限:需要超级管理员权限
接口说明:修改分类和标签
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.editMeta() (https://api.ruletree.club/typechoMetas/editMeta)
5. addMeta
接口路径:GET/POST /typechoMetas/addMeta
权限:需要超级管理员权限
接口说明:修改分类和标签
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.addMeta() (https://api.ruletree.club/typechoMetas/addMeta)
6. deleteMeta
接口路径:GET/POST /typechoMetas/deleteMeta
权限:需要超级管理员权限
接口说明:删除分类和标签
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | String | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.deleteMeta() (https://api.ruletree.club/typechoMetas/deleteMeta)
7. addRecommend
接口路径:GET/POST /typechoMetas/toRecommend
权限:需要超级管理员权限
接口说明:删除分类和标签
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| key | String | 否 | - | |
| recommend | Integer | 否 | 1 | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.metaRecommend() (https://api.ruletree.club/typechoMetas/toRecommend)
- 前端调用:this.$API.toRecommend() (https://api.ruletree.club/typechoContents/toRecommend)