标签模块
查看后台标签列表
接口描述:
接口地址:/admin/tags
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| current | 当前页码 | query | true | integer | |
| size | 显示数量 | query | true | integer | |
| keywords | 搜索内容 | query | true | string | |
| categoryId | 分类id | query | false | integer | |
| tagId | 标签id | query | false | integer | |
| isDelete | 是否删除 | query | false | integer | |
| isDraft | 草稿状态 | query | false | integer | |
| startTime | 开始时间 | query | false | string | |
| endTime | 结束时间 | query | false | string |
响应示例:
{
"code": 0,
"data": {
"count": 0,
"recordList": [
{
"createTime": "",
"id": 0,
"tagName": ""
}
]
},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | PageDTO«Tag» | PageDTO«Tag» | |
| flag | boolean | ||
| message | string |
schema属性说明
PageDTO«Tag»
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| count | integer(int32) | ||
| recordList | array | Tag |
Tag
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| createTime | string(date-time) | ||
| id | integer(int32) | ||
| tagName | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«PageDTO«Tag»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |
添加或修改标签
接口描述:
接口地址:/admin/tags
请求方式:POST
consumes:["application/json"]
produces:["*/*"]
请求示例:
{
"id": 0,
"tagName": ""
}
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| tagVO | 标签对象 | body | true | TagVO | TagVO |
schema属性说明
TagVO
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | 标签id | body | false | integer(int32) | |
| tagName | 标签名 | body | true | string |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |
删除标签
接口描述:
接口地址:/admin/tags
请求方式:DELETE
consumes:["application/json"]
produces:["*/*"]
请求示例:
[
0
]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| tagIdList | tagIdList | body | true | array | integer |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
查看标签列表
接口描述:
接口地址:/tags
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数: 暂无
响应示例:
{
"code": 0,
"data": {
"count": 0,
"recordList": [
{
"id": 0,
"tagName": ""
}
]
},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | PageDTO«TagDTO» | PageDTO«TagDTO» | |
| flag | boolean | ||
| message | string |
schema属性说明
PageDTO«TagDTO»
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| count | integer(int32) | ||
| recordList | array | TagDTO |
TagDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| id | integer(int32) | ||
| tagName | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«PageDTO«TagDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |
查看标签下对应的文章
接口描述:
接口地址:/tags/{tagId}
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| tagId | tagId | path | true | integer | |
| current | current | query | false | integer |
响应示例:
{
"code": 0,
"data": {
"articlePreviewDTOList": [
{
"articleCover": "",
"articleTitle": "",
"categoryId": 0,
"categoryName": "",
"createTime": "",
"id": 0,
"tagDTOList": [
{
"id": 0,
"tagName": ""
}
]
}
],
"name": ""
},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | ArticlePreviewListDTO | ArticlePreviewListDTO | |
| flag | boolean | ||
| message | string |
schema属性说明
ArticlePreviewListDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| articlePreviewDTOList | array | ArticlePreviewDTO | |
| name | string |
ArticlePreviewDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| articleCover | string | ||
| articleTitle | string | ||
| categoryId | integer(int32) | ||
| categoryName | string | ||
| createTime | string(date-time) | ||
| id | integer(int32) | ||
| tagDTOList | array | TagDTO |
TagDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| id | integer(int32) | ||
| tagName | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«ArticlePreviewListDTO» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
分类模块
查看后台分类列表
接口描述:
接口地址:/admin/categories
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| categoryId | 分类id | query | false | integer | |
| tagId | 标签id | query | false | integer | |
| current | 当前页码 | query | true | integer | |
| size | 显示数量 | query | true | integer | |
| keywords | 搜索内容 | query | true | string | |
| isDelete | 是否删除 | query | false | integer | |
| isDraft | 草稿状态 | query | false | integer | |
| startTime | 开始时间 | query | false | string | |
| endTime | 结束时间 | query | false | string |
响应示例:
{
"code": 0,
"data": {
"count": 0,
"recordList": [
{
"categoryName": "",
"createTime": "",
"id": 0
}
]
},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | PageDTO«Category» | PageDTO«Category» | |
| flag | boolean | ||
| message | string |
schema属性说明
PageDTO«Category»
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| count | integer(int32) | ||
| recordList | array | Category |
Category
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| categoryName | string | ||
| createTime | string(date-time) | ||
| id | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«PageDTO«Category»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
添加或修改分类
接口描述:
接口地址:/admin/categories
请求方式:POST
consumes:["application/json"]
produces:["*/*"]
请求示例:
{
"categoryName": "",
"id": 0
}
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| categoryVO | 分类 | body | true | CategoryVO | CategoryVO |
schema属性说明
CategoryVO
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| categoryName | 分类名 | body | true | string | |
| id | 分类id | body | false | integer(int32) |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
删除分类
接口描述:
接口地址:/admin/categories
请求方式:DELETE
consumes:["application/json"]
produces:["*/*"]
请求示例:
[
0
]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| categoryIdList | categoryIdList | body | true | array | integer |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
查看分类列表--------
接口描述:
接口地址:/categories
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数: 暂无
响应示例:
{
"code": 0,
"data": {
"count": 0,
"recordList": [
{
"articleCount": 0,
"categoryName": "",
"id": 0
}
]
},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | PageDTO«CategoryDTO» | PageDTO«CategoryDTO» | |
| flag | boolean | ||
| message | string |
schema属性说明
PageDTO«CategoryDTO»
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| count | integer(int32) | ||
| recordList | array | CategoryDTO |
CategoryDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| articleCount | integer(int32) | ||
| categoryName | string | ||
| id | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«PageDTO«CategoryDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
查看分类下对应的文章
接口描述:
接口地址:/categories/{categoryId}
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| categoryId | categoryId | path | true | integer | |
| current | current | query | false | integer |
响应示例:
{
"code": 0,
"data": {
"articlePreviewDTOList": [
{
"articleCover": "",
"articleTitle": "",
"categoryId": 0,
"categoryName": "",
"createTime": "",
"id": 0,
"tagDTOList": [
{
"id": 0,
"tagName": ""
}
]
}
],
"name": ""
},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | ArticlePreviewListDTO | ArticlePreviewListDTO | |
| flag | boolean | ||
| message | string |
schema属性说明
ArticlePreviewListDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| articlePreviewDTOList | array | ArticlePreviewDTO | |
| name | string |
ArticlePreviewDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| articleCover | string | ||
| articleTitle | string | ||
| categoryId | integer(int32) | ||
| categoryName | string | ||
| createTime | string(date-time) | ||
| id | integer(int32) | ||
| tagDTOList | array | TagDTO |
TagDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| id | integer(int32) | ||
| tagName | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«ArticlePreviewListDTO» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
友链模块
查看后台友链列表
接口描述:
接口地址:/admin/links
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| categoryId | 分类id | query | false | integer | |
| tagId | 标签id | query | false | integer | |
| current | 当前页码 | query | true | integer | |
| size | 显示数量 | query | true | integer | |
| keywords | 搜索内容 | query | true | string | |
| isDelete | 是否删除 | query | false | integer | |
| isDraft | 草稿状态 | query | false | integer | |
| startTime | 开始时间 | query | false | string | |
| endTime | 结束时间 | query | false | string |
响应示例:
{
"code": 0,
"data": {
"count": 0,
"recordList": [
{
"createTime": "",
"id": 0,
"linkAddress": "",
"linkAvatar": "",
"linkIntro": "",
"linkName": ""
}
]
},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | PageDTO«FriendLinkBackDTO» | PageDTO«FriendLinkBackDTO» | |
| flag | boolean | ||
| message | string |
schema属性说明
PageDTO«FriendLinkBackDTO»
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| count | integer(int32) | ||
| recordList | array | FriendLinkBackDTO |
FriendLinkBackDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| createTime | string(date-time) | ||
| id | integer(int32) | ||
| linkAddress | string | ||
| linkAvatar | string | ||
| linkIntro | string | ||
| linkName | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«PageDTO«FriendLinkBackDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
保存或修改友链
接口描述:
接口地址:/admin/links
请求方式:POST
consumes:["application/json"]
produces:["*/*"]
请求示例:
{
"id": 0,
"linkAddress": "",
"linkAvatar": "",
"linkIntro": "",
"linkName": ""
}
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| friendLinkVO | 友链 | body | true | FriendLinkVO | FriendLinkVO |
schema属性说明
FriendLinkVO
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | 友链id | body | false | integer(int32) | |
| linkAddress | 友链头像 | body | true | string | |
| linkAvatar | 友链头像 | body | true | string | |
| linkIntro | 友链头像 | body | true | string | |
| linkName | 友链名 | body | true | string |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
删除友链
接口描述:
接口地址:/admin/links
请求方式:DELETE
consumes:["application/json"]
produces:["*/*"]
请求示例:
[
0
]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| linkIdList | linkIdList | body | true | array | integer |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
查看友链列表
接口描述:
接口地址:/links
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数: 暂无
响应示例:
{
"code": 0,
"data": [
{
"id": 0,
"linkAddress": "",
"linkAvatar": "",
"linkIntro": "",
"linkName": ""
}
],
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | array | FriendLinkDTO | |
| flag | boolean | ||
| message | string |
schema属性说明
FriendLinkDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| id | integer(int32) | ||
| linkAddress | string | ||
| linkAvatar | string | ||
| linkIntro | string | ||
| linkName | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«List«FriendLinkDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
日志模块
查看操作日志
接口描述:
接口地址:/admin/operation/logs
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| categoryId | 分类id | query | false | integer | |
| tagId | 标签id | query | false | integer | |
| current | 当前页码 | query | true | integer | |
| size | 显示数量 | query | true | integer | |
| keywords | 搜索内容 | query | true | string | |
| isDelete | 是否删除 | query | false | integer | |
| isDraft | 草稿状态 | query | false | integer | |
| startTime | 开始时间 | query | false | string | |
| endTime | 结束时间 | query | false | string |
响应示例:
{
"code": 0,
"data": {
"count": 0,
"recordList": [
{
"createTime": "",
"id": 0,
"ipAddr": "",
"ipSource": "",
"nickname": "",
"optDesc": "",
"optMethod": "",
"optModule": "",
"optType": "",
"optUrl": "",
"requestMethod": "",
"requestParam": "",
"responseData": ""
}
]
},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | PageDTO«OperationLogDTO» | PageDTO«OperationLogDTO» | |
| flag | boolean | ||
| message | string |
schema属性说明
PageDTO«OperationLogDTO»
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| count | integer(int32) | ||
| recordList | array | OperationLogDTO |
OperationLogDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| createTime | string(date-time) | ||
| id | integer(int32) | ||
| ipAddr | string | ||
| ipSource | string | ||
| nickname | string | ||
| optDesc | string | ||
| optMethod | string | ||
| optModule | string | ||
| optType | string | ||
| optUrl | string | ||
| requestMethod | string | ||
| requestParam | string | ||
| responseData | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«PageDTO«OperationLogDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
删除操作日志
接口描述:
接口地址:/admin/operation/logs
请求方式:DELETE
consumes:["application/json"]
produces:["*/*"]
请求示例:
[
0
]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| logIdList | logIdList | body | true | array | integer |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
资源模块
查看资源列表
接口描述:
接口地址:/admin/resources
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数: 暂无
响应示例:
{
"code": 0,
"data": [
{
"children": [
{
"children": [
{}
],
"createTime": "",
"id": 0,
"isAnonymous": 0,
"isDisable": 0,
"requestMethod": "",
"resourceName": "",
"url": ""
}
],
"createTime": "",
"id": 0,
"isAnonymous": 0,
"isDisable": 0,
"requestMethod": "",
"resourceName": "",
"url": ""
}
],
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | array | ResourceDTO | |
| flag | boolean | ||
| message | string |
schema属性说明
ResourceDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| children | array | ResourceDTO | |
| createTime | string(date-time) | ||
| id | integer(int32) | ||
| isAnonymous | integer(int32) | ||
| isDisable | integer(int32) | ||
| requestMethod | string | ||
| resourceName | string | ||
| url | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«List«ResourceDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
新增或修改资源
接口描述:
接口地址:/admin/resources
请求方式:POST
consumes:["application/json"]
produces:["*/*"]
请求示例:
{
"id": 0,
"isAnonymous": 0,
"isDisable": 0,
"parentId": 0,
"requestMethod": "",
"resourceName": "",
"url": ""
}
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| resourceVO | 资源 | body | true | ResourceVO | ResourceVO |
schema属性说明
ResourceVO
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | 资源id | body | true | integer(int32) | |
| isAnonymous | 是否匿名访问 | body | true | integer(int32) | |
| isDisable | 是否禁用 | body | true | integer(int32) | |
| parentId | 父资源id | body | true | integer(int32) | |
| requestMethod | 资源路径 | body | true | string | |
| resourceName | 资源名 | body | true | string | |
| url | 资源路径 | body | true | string |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
删除资源
接口描述:
接口地址:/admin/resources
请求方式:DELETE
consumes:["application/json"]
produces:["*/*"]
请求示例:
[
0
]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| resourceIdList | resourceIdList | body | true | array | integer |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
导入swagger接口
接口描述:
接口地址:/admin/resources/import/swagger
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数: 暂无
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
查看角色资源选项
接口描述:
接口地址:/admin/role/resources
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数: 暂无
响应示例:
{
"code": 0,
"data": [
{
"children": [
{
"children": [
{}
],
"id": 0,
"label": ""
}
],
"id": 0,
"label": ""
}
],
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | array | labelOptionDTO | |
| flag | boolean | ||
| message | string |
schema属性说明
labelOptionDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| children | array | labelOptionDTO | |
| id | integer(int32) | ||
| label | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«List«labelOptionDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
评论模块
查询后台评论
接口描述:
接口地址:/admin/comments
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| categoryId | 分类id | query | false | integer | |
| tagId | 标签id | query | false | integer | |
| current | 当前页码 | query | true | integer | |
| size | 显示数量 | query | true | integer | |
| keywords | 搜索内容 | query | true | string | |
| isDelete | 是否删除 | query | false | integer | |
| isDraft | 草稿状态 | query | false | integer | |
| startTime | 开始时间 | query | false | string | |
| endTime | 结束时间 | query | false | string |
响应示例:
{
"code": 0,
"data": {
"count": 0,
"recordList": [
{
"articleTitle": "",
"avatar": "",
"commentContent": "",
"createTime": "",
"id": 0,
"isDelete": 0,
"likeCount": 0,
"nickname": "",
"replyNickname": ""
}
]
},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | PageDTO«CommentBackDTO» | PageDTO«CommentBackDTO» | |
| flag | boolean | ||
| message | string |
schema属性说明
PageDTO«CommentBackDTO»
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| count | integer(int32) | ||
| recordList | array | CommentBackDTO |
CommentBackDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| articleTitle | string | ||
| avatar | string | ||
| commentContent | string | ||
| createTime | string(date-time) | ||
| id | integer(int32) | ||
| isDelete | integer(int32) | ||
| likeCount | integer(int32) | ||
| nickname | string | ||
| replyNickname | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«PageDTO«CommentBackDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
删除或恢复评论
接口描述:
接口地址:/admin/comments
请求方式:PUT
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| idList | id列表 | query | true | array | integer |
| isDelete | 删除状态 | query | true | integer |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
物理删除评论
接口描述:
接口地址:/admin/comments
请求方式:DELETE
consumes:["application/json"]
produces:["*/*"]
请求示例:
[
0
]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| commentIdList | commentIdList | body | true | array | integer |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
查询评论
接口描述:
接口地址:/comments
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| articleId | 文章id | body | true | Integer | Integer |
| current | 当前页码 | body | true | Long | Long |
响应示例:
{
"code": 0,
"data": {
"count": 0,
"recordList": [
{
"avatar": "",
"commentContent": "",
"createTime": "",
"id": 0,
"likeCount": 0,
"nickname": "",
"replyCount": 0,
"replyDTOList": [
{
"avatar": "",
"commentContent": "",
"createTime": "",
"id": 0,
"likeCount": 0,
"nickname": "",
"parentId": 0,
"replyId": 0,
"replyNickname": "",
"replyWebSite": "",
"userId": 0,
"webSite": ""
}
],
"userId": 0,
"webSite": ""
}
]
},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | PageDTO«CommentDTO» | PageDTO«CommentDTO» | |
| flag | boolean | ||
| message | string |
schema属性说明
PageDTO«CommentDTO»
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| count | integer(int32) | ||
| recordList | array | CommentDTO |
CommentDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| avatar | string | ||
| commentContent | string | ||
| createTime | string(date-time) | ||
| id | integer(int32) | ||
| likeCount | integer(int32) | ||
| nickname | string | ||
| replyCount | integer(int32) | ||
| replyDTOList | array | ReplyDTO | |
| userId | integer(int32) | ||
| webSite | string |
ReplyDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| avatar | string | ||
| commentContent | string | ||
| createTime | string(date-time) | ||
| id | integer(int32) | ||
| likeCount | integer(int32) | ||
| nickname | string | ||
| parentId | integer(int32) | ||
| replyId | integer(int32) | ||
| replyNickname | string | ||
| replyWebSite | string | ||
| userId | integer(int32) | ||
| webSite | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«PageDTO«CommentDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
添加评论或回复
接口描述:
接口地址:/comments
请求方式:POST
consumes:["application/json"]
produces:["*/*"]
请求示例:
{
"articleId": 0,
"commentContent": "",
"parentId": 0,
"replyId": 0
}
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| commentVO | 评论 | body | true | CommentVO | CommentVO |
schema属性说明
CommentVO
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| articleId | 文章id | body | false | integer(int32) | |
| commentContent | 评论内容 | body | true | string | |
| parentId | 评论父id | body | false | integer(int32) | |
| replyId | 回复用户id | body | false | integer(int32) |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
评论点赞
接口描述:
接口地址:/comments/like
请求方式:POST
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| commentId | commentId | query | false | integer |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
查询评论下的回复
接口描述:
接口地址:/comments/replies/{commentId}
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| commentId | 文章id | body | true | Integer | Integer |
| current | 当前页码 | body | true | Long | Long |
响应示例:
{
"code": 0,
"data": [
{
"avatar": "",
"commentContent": "",
"createTime": "",
"id": 0,
"likeCount": 0,
"nickname": "",
"parentId": 0,
"replyId": 0,
"replyNickname": "",
"replyWebSite": "",
"userId": 0,
"webSite": ""
}
],
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | array | ReplyDTO | |
| flag | boolean | ||
| message | string |
schema属性说明
ReplyDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| avatar | string | ||
| commentContent | string | ||
| createTime | string(date-time) | ||
| id | integer(int32) | ||
| likeCount | integer(int32) | ||
| nickname | string | ||
| parentId | integer(int32) | ||
| replyId | integer(int32) | ||
| replyNickname | string | ||
| replyWebSite | string | ||
| userId | integer(int32) | ||
| webSite | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«List«ReplyDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
留言模块
查看后台留言列表
接口描述:
接口地址:/admin/messages
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| categoryId | 分类id | query | false | integer | |
| tagId | 标签id | query | false | integer | |
| current | 当前页码 | query | true | integer | |
| size | 显示数量 | query | true | integer | |
| keywords | 搜索内容 | query | true | string | |
| isDelete | 是否删除 | query | false | integer | |
| isDraft | 草稿状态 | query | false | integer | |
| startTime | 开始时间 | query | false | string | |
| endTime | 结束时间 | query | false | string |
响应示例:
{
"code": 0,
"data": {
"count": 0,
"recordList": [
{
"avatar": "",
"createTime": "",
"id": 0,
"ipAddress": "",
"ipSource": "",
"messageContent": "",
"nickname": ""
}
]
},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | PageDTO«MessageBackDTO» | PageDTO«MessageBackDTO» | |
| flag | boolean | ||
| message | string |
schema属性说明
PageDTO«MessageBackDTO»
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| count | integer(int32) | ||
| recordList | array | MessageBackDTO |
MessageBackDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| avatar | string | ||
| createTime | string(date-time) | ||
| id | integer(int32) | ||
| ipAddress | string | ||
| ipSource | string | ||
| messageContent | string | ||
| nickname | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«PageDTO«MessageBackDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |
删除留言
接口描述:
接口地址:/admin/messages
请求方式:DELETE
consumes:["application/json"]
produces:["*/*"]
请求示例:
[
0
]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| messageIdList | messageIdList | body | true | array | integer |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
查看留言列表
接口描述:
接口地址:/messages
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数: 暂无
响应示例:
{
"code": 0,
"data": [
{
"avatar": "",
"id": 0,
"messageContent": "",
"nickname": "",
"time": 0
}
],
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | array | MessageDTO | |
| flag | boolean | ||
| message | string |
schema属性说明
MessageDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| avatar | string | ||
| id | integer(int32) | ||
| messageContent | string | ||
| nickname | string | ||
| time | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«List«MessageDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |
添加留言
接口描述:
接口地址:/messages
请求方式:POST
consumes:["application/json"]
produces:["*/*"]
请求示例:
{
"avatar": "",
"messageContent": "",
"nickname": "",
"time": 0
}
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| messageVO | 留言 | body | true | MessageVO | MessageVO |
schema属性说明
MessageVO
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| avatar | 头像 | body | true | string | |
| messageContent | 留言内容 | body | true | string | |
| nickname | 昵称 | body | true | string | |
| time | 弹幕速度 | body | true | integer(int32) |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
菜单模块
查看菜单列表
接口描述:
接口地址:/admin/menus
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| categoryId | 分类id | query | false | integer | |
| tagId | 标签id | query | false | integer | |
| current | 当前页码 | query | true | integer | |
| size | 显示数量 | query | true | integer | |
| keywords | 搜索内容 | query | true | string | |
| isDelete | 是否删除 | query | false | integer | |
| isDraft | 草稿状态 | query | false | integer | |
| startTime | 开始时间 | query | false | string | |
| endTime | 结束时间 | query | false | string |
响应示例:
{
"code": 0,
"data": [
{
"children": [
{
"children": [
{}
],
"component": "",
"createTime": "",
"icon": "",
"id": 0,
"isDisable": 0,
"isHidden": 0,
"name": "",
"orderNum": 0,
"path": ""
}
],
"component": "",
"createTime": "",
"icon": "",
"id": 0,
"isDisable": 0,
"isHidden": 0,
"name": "",
"orderNum": 0,
"path": ""
}
],
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | array | MenuDTO | |
| flag | boolean | ||
| message | string |
schema属性说明
MenuDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| children | array | MenuDTO | |
| component | string | ||
| createTime | string(date-time) | ||
| icon | string | ||
| id | integer(int32) | ||
| isDisable | integer(int32) | ||
| isHidden | integer(int32) | ||
| name | string | ||
| orderNum | integer(int32) | ||
| path | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«List«MenuDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |
查看角色菜单选项
接口描述:
接口地址:/admin/role/menus
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数: 暂无
响应示例:
{
"code": 0,
"data": [
{
"children": [
{
"children": [
{}
],
"id": 0,
"label": ""
}
],
"id": 0,
"label": ""
}
],
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | array | labelOptionDTO | |
| flag | boolean | ||
| message | string |
schema属性说明
labelOptionDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| children | array | labelOptionDTO | |
| id | integer(int32) | ||
| label | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«List«labelOptionDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |
查看用户菜单
接口描述:
接口地址:/admin/user/menus
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数: 暂无
响应示例:
{
"code": 0,
"data": [
{
"children": [
{
"children": [
{}
],
"component": "",
"hidden": true,
"icon": "",
"name": "",
"path": ""
}
],
"component": "",
"hidden": true,
"icon": "",
"name": "",
"path": ""
}
],
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | array | UserMenuDTO | |
| flag | boolean | ||
| message | string |
schema属性说明
UserMenuDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| children | array | UserMenuDTO | |
| component | string | ||
| hidden | boolean | ||
| icon | string | ||
| name | string | ||
| path | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«List«UserMenuDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
文章模块
查看后台文章
接口描述:
接口地址:/admin/articles
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| categoryId | 分类id | query | false | integer | |
| tagId | 标签id | query | false | integer | |
| current | 当前页码 | query | true | integer | |
| size | 显示数量 | query | true | integer | |
| keywords | 搜索内容 | query | true | string | |
| isDelete | 是否删除 | query | false | integer | |
| isDraft | 草稿状态 | query | false | integer | |
| startTime | 开始时间 | query | false | string | |
| endTime | 结束时间 | query | false | string |
响应示例:
{
"code": 0,
"data": {
"count": 0,
"recordList": [
{
"articleTitle": "",
"categoryName": "",
"createTime": "",
"id": 0,
"isDelete": 0,
"isDraft": 0,
"isTop": 0,
"likeCount": 0,
"tagDTOList": [
{
"id": 0,
"tagName": ""
}
],
"updateTime": "",
"viewsCount": 0
}
]
},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | PageDTO«ArticleBackDTO» | PageDTO«ArticleBackDTO» | |
| flag | boolean | ||
| message | string |
schema属性说明
PageDTO«ArticleBackDTO»
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| count | integer(int32) | ||
| recordList | array | ArticleBackDTO |
ArticleBackDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| articleTitle | string | ||
| categoryName | string | ||
| createTime | string(date-time) | ||
| id | integer(int32) | ||
| isDelete | integer(int32) | ||
| isDraft | integer(int32) | ||
| isTop | integer(int32) | ||
| likeCount | integer(int32) | ||
| tagDTOList | array | TagDTO | |
| updateTime | string(date-time) | ||
| viewsCount | integer(int32) |
TagDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| id | integer(int32) | ||
| tagName | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«PageDTO«ArticleBackDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
添加或修改文章
接口描述:
接口地址:/admin/articles
请求方式:POST
consumes:["application/json"]
produces:["*/*"]
请求示例:
{
"articleContent": "",
"articleCover": "",
"articleTitle": "",
"categoryId": 0,
"id": 0,
"isDraft": 0,
"isTop": 0,
"tagIdList": []
}
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| articleVO | 文章 | body | true | ArticleVO | ArticleVO |
schema属性说明
ArticleVO
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| articleContent | 文章内容 | body | true | string | |
| articleCover | 文章缩略图 | body | false | string | |
| articleTitle | 文章标题 | body | true | string | |
| categoryId | 文章分类 | body | false | integer(int32) | |
| id | 文章id | body | false | integer(int32) | |
| isDraft | 是否为草稿 | body | false | integer(int32) | |
| isTop | 是否置顶 | body | false | integer(int32) | |
| tagIdList | 文章标签 | body | false | array |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
恢复或删除文章
接口描述:
接口地址:/admin/articles
请求方式:PUT
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| idList | id列表 | query | true | array | integer |
| isDelete | 删除状态 | query | true | integer |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
物理删除文章
接口描述:
接口地址:/admin/articles
请求方式:DELETE
consumes:["application/json"]
produces:["*/*"]
请求示例:
[
0
]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| articleIdList | articleIdList | body | true | array | integer |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
上传文章图片
接口描述:
接口地址:/admin/articles/images
请求方式:POST
consumes:["multipart/form-data"]
produces:["*/*"]
请求示例:
null
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| file | 文章图片 | body | true | MultipartFile | MultipartFile |
响应示例:
{
"code": 0,
"data": "",
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | string | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«string» |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
查看文章选项
接口描述:
接口地址:/admin/articles/options
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数: 暂无
响应示例:
{
"code": 0,
"data": {
"categoryDTOList": [
{
"categoryName": "",
"id": 0
}
],
"tagDTOList": [
{
"id": 0,
"tagName": ""
}
]
},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | ArticleOptionDTO | ArticleOptionDTO | |
| flag | boolean | ||
| message | string |
schema属性说明
ArticleOptionDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| categoryDTOList | array | CategoryBackDTO | |
| tagDTOList | array | TagDTO |
CategoryBackDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| categoryName | string | ||
| id | integer(int32) |
TagDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| id | integer(int32) | ||
| tagName | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«ArticleOptionDTO» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
修改文章置顶
接口描述:
接口地址:/admin/articles/top/{articleId}
请求方式:PUT
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| articleId | articleId | path | true | integer | |
| isTop | isTop | query | false | integer |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
根据id查看后台文章
接口描述:
接口地址:/admin/articles/{articleId}
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求示例:
null
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| articleId | 文章id | body | true | Integer | Integer |
响应示例:
{
"code": 0,
"data": {
"articleContent": "",
"articleCover": "",
"articleTitle": "",
"categoryId": 0,
"id": 0,
"isDraft": 0,
"isTop": 0,
"tagIdList": []
},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | ArticleVO | ArticleVO | |
| flag | boolean | ||
| message | string |
schema属性说明
ArticleVO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| articleContent | 文章内容 | string | |
| articleCover | 文章缩略图 | string | |
| articleTitle | 文章标题 | string | |
| categoryId | 文章分类 | integer(int32) | |
| id | 文章id | integer(int32) | |
| isDraft | 是否为草稿 | integer(int32) | |
| isTop | 是否置顶 | integer(int32) | |
| tagIdList | 文章标签 | array |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«ArticleVO» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
查看首页文章 ------
接口描述:
接口地址:/articles
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求示例:
null
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| current | 当前页码 | body | true | Long | Long |
响应示例:
{
"code": 0,
"data": [
{
"articleContent": "",
"articleCover": "",
"articleTitle": "",
"categoryId": 0,
"categoryName": "",
"createTime": "",
"id": 0,
"isTop": true,
"tagDTOList": [
{
"id": 0,
"tagName": ""
}
]
}
],
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | array | ArticleHomeDTO | |
| flag | boolean | ||
| message | string |
schema属性说明
ArticleHomeDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| articleContent | string | ||
| articleCover | string | ||
| articleTitle | string | ||
| categoryId | integer(int32) | ||
| categoryName | string | ||
| createTime | string(date-time) | ||
| id | integer(int32) | ||
| isTop | boolean | ||
| tagDTOList | array | TagDTO |
TagDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| id | integer(int32) | ||
| tagName | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«List«ArticleHomeDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
查看文章归档------
接口描述:
接口地址:/articles/archives
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求示例:
null
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| current | 当前页码 | body | true | Long | Long |
响应示例:
{
"code": 0,
"data": {
"count": 0,
"recordList": [
{
"articleTitle": "",
"createTime": "",
"id": 0
}
]
},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | PageDTO«ArchiveDTO» | PageDTO«ArchiveDTO» | |
| flag | boolean | ||
| message | string |
schema属性说明
PageDTO«ArchiveDTO»
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| count | integer(int32) | ||
| recordList | array | ArchiveDTO |
ArchiveDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| createTime | string(date-time) | ||
| articleTitle | string | ||
| id | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«PageDTO«ArchiveDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
点赞文章
接口描述:
接口地址:/articles/like
请求方式:POST
consumes:["application/json"]
produces:["*/*"]
请求示例:
null
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| articleId | 文章id | body | true | Integer | Integer |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
查看最新文章
接口描述:
接口地址:/articles/newest
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数: 暂无
响应示例:
{
"code": 0,
"data": [
{
"articleCover": "",
"articleTitle": "",
"createTime": "",
"id": 0
}
],
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | array | ArticleRecommendDTO | |
| flag | boolean | ||
| message | string |
schema属性说明
ArticleRecommendDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| articleCover | string | ||
| articleTitle | string | ||
| createTime | string(date-time) | ||
| id | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«List«ArticleRecommendDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
搜索文章
接口描述:
接口地址:/articles/search
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| categoryId | 分类id | query | false | integer | |
| tagId | 标签id | query | false | integer | |
| current | 当前页码 | query | true | integer | |
| size | 显示数量 | query | true | integer | |
| keywords | 搜索内容 | query | true | string | |
| isDelete | 是否删除 | query | false | integer | |
| isDraft | 草稿状态 | query | false | integer | |
| startTime | 开始时间 | query | false | string | |
| endTime | 结束时间 | query | false | string |
响应示例:
{
"code": 0,
"data": [
{
"articleContent": "",
"articleTitle": "",
"id": 0,
"isDelete": 0
}
],
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | array | ArticleSearchDTO | |
| flag | boolean | ||
| message | string |
schema属性说明
ArticleSearchDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| articleContent | string | ||
| articleTitle | string | ||
| id | integer(int32) | ||
| isDelete | integer(int32) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«List«ArticleSearchDTO»» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
根据id查看文章-------
接口描述:
接口地址:/articles/{articleId}
请求方式:GET
consumes:["application/json"]
produces:["*/*"]
请求示例:
null
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| articleId | 文章id | body | true | Integer | Integer |
响应示例:
{
"code": 0,
"data": {
"articleContent": "",
"articleCover": "",
"articleRecommendList": [
{
"articleCover": "",
"articleTitle": "",
"createTime": "",
"id": 0
}
],
"articleTitle": "",
"categoryId": 0,
"categoryName": "",
"createTime": "",
"id": 0,
"lastArticle": {
"articleCover": "",
"articleTitle": "",
"id": 0
},
"likeCount": 0,
"nextArticle": {
"articleCover": "",
"articleTitle": "",
"id": 0
},
"tagDTOList": [
{
"id": 0,
"tagName": ""
}
],
"updateTime": "",
"viewsCount": 0
},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | ArticleDTO | ArticleDTO | |
| flag | boolean | ||
| message | string |
schema属性说明
ArticleDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| articleContent | string | ||
| articleCover | string | ||
| articleRecommendList | array | ArticleRecommendDTO | |
| articleTitle | string | ||
| categoryId | integer(int32) | ||
| categoryName | string | ||
| createTime | string(date-time) | ||
| id | integer(int32) | ||
| lastArticle | ArticlePaginationDTO | ArticlePaginationDTO | |
| likeCount | integer(int32) | ||
| nextArticle | ArticlePaginationDTO | ArticlePaginationDTO | |
| tagDTOList | array | TagDTO | |
| updateTime | string(date-time) | ||
| viewsCount | integer(int32) |
ArticleRecommendDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| articleCover | string | ||
| articleTitle | string | ||
| createTime | string(date-time) | ||
| id | integer(int32) |
ArticlePaginationDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| articleCover | string | ||
| articleTitle | string | ||
| id | integer(int32) |
TagDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| id | integer(int32) | ||
| tagName | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result«ArticleDTO» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
角色模块
保存或更新角色
接口描述:
接口地址:/admin/role
请求方式:POST
consumes:["application/json"]
produces:["*/*"]
请求示例:
{
"id": 0,
"menuIdList": [],
"resourceIdList": [],
"roleLabel": "",
"roleName": ""
}
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| roleVO | 角色 | body | true | RoleVO | RoleVO |
schema属性说明
RoleVO
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| id | 用户id | body | false | integer(int32) | |
| menuIdList | 菜单列表 | body | true | array | |
| resourceIdList | 资源列表 | body | true | array | |
| roleLabel | 标签名 | body | true | string | |
| roleName | 标签名 | body | true | string |
响应示例:
{
"code": 0,
"data": {},
"flag": true,
"message": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int32) | integer(int32) | |
| data | object | ||
| flag | boolean | ||
| message | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | Result |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |