blog2

111 阅读14分钟

查询角色列表

接口描述:

接口地址:/admin/roles

请求方式GET

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称参数说明in是否必须数据类型schema
categoryId分类idqueryfalseinteger
tagId标签idqueryfalseinteger
current当前页码querytrueinteger
size显示数量querytrueinteger
keywords搜索内容querytruestring
isDelete是否删除queryfalseinteger
isDraft草稿状态queryfalseinteger
startTime开始时间queryfalsestring
endTime结束时间queryfalsestring

响应示例:

{
	"code": 0,
	"data": [
		{
			"id": 0,
			"roleName": ""
		}
	],
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataarrayUserRoleDTO
flagboolean
messagestring

schema属性说明

UserRoleDTO

参数名称参数说明类型schema
idinteger(int32)
roleNamestring

响应状态:

状态码说明schema
200OKResult«List«UserRoleDTO»»
401Unauthorized
403Forbidden
404Not Found

删除角色

接口描述:

接口地址:/admin/roles

请求方式DELETE

consumes:["application/json"]

produces:["*/*"]

请求示例

[
	0
]

请求参数

参数名称参数说明in是否必须数据类型schema
roleIdListroleIdListbodytruearrayinteger

响应示例:

{
	"code": 0,
	"data": {},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
flagboolean
messagestring

响应状态:

状态码说明schema
200OKResult
204No Content
401Unauthorized
403Forbidden

查询用户角色选项

接口描述:

接口地址:/admin/users/role

请求方式GET

consumes:["application/json"]

produces:["*/*"]

请求参数: 暂无

响应示例:

{
	"code": 0,
	"data": [
		{
			"id": 0,
			"roleName": ""
		}
	],
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataarrayUserRoleDTO
flagboolean
messagestring

schema属性说明

UserRoleDTO

参数名称参数说明类型schema
idinteger(int32)
roleNamestring

响应状态:

状态码说明schema
200OKResult«List«UserRoleDTO»»
401Unauthorized
403Forbidden
404Not Found

用户账号模块

查看后台用户列表

接口描述:

接口地址:/admin/users

请求方式GET

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称参数说明in是否必须数据类型schema
categoryId分类idqueryfalseinteger
tagId标签idqueryfalseinteger
current当前页码querytrueinteger
size显示数量querytrueinteger
keywords搜索内容querytruestring
isDelete是否删除queryfalseinteger
isDraft草稿状态queryfalseinteger
startTime开始时间queryfalsestring
endTime结束时间queryfalsestring

响应示例:

{
	"code": 0,
	"data": {
		"count": 0,
		"recordList": [
			{
				"avatar": "",
				"createTime": "",
				"id": 0,
				"ipAddr": "",
				"ipSource": "",
				"isDisable": 0,
				"lastLoginTime": "",
				"loginType": 0,
				"nickname": "",
				"roleList": [
					{
						"id": 0,
						"roleName": ""
					}
				],
				"status": 0,
				"userInfoId": 0
			}
		]
	},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataPageDTO«UserBackDTO»PageDTO«UserBackDTO»
flagboolean
messagestring

schema属性说明

PageDTO«UserBackDTO»

参数名称参数说明类型schema
countinteger(int32)
recordListarrayUserBackDTO

UserBackDTO

参数名称参数说明类型schema
avatarstring
createTimestring(date-time)
idinteger(int32)
ipAddrstring
ipSourcestring
isDisableinteger(int32)
lastLoginTimestring(date-time)
loginTypeinteger(int32)
nicknamestring
roleListarrayUserRoleDTO
statusinteger(int32)
userInfoIdinteger(int32)

UserRoleDTO

参数名称参数说明类型schema
idinteger(int32)
roleNamestring

响应状态:

状态码说明schema
200OKResult«PageDTO«UserBackDTO»»
401Unauthorized
403Forbidden
404Not Found

修改管理员密码

接口描述:

接口地址:/admin/users/password

请求方式PUT

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"newPassword": "",
	"oldPassword": ""
}

请求参数

参数名称参数说明in是否必须数据类型schema
passwordVO密码bodytruePasswordVOPasswordVO

schema属性说明

PasswordVO

参数名称参数说明in是否必须数据类型schema
newPassword新密码bodytruestring
oldPassword旧密码bodytruestring

响应示例:

{
	"code": 0,
	"data": {},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
flagboolean
messagestring

响应状态:

状态码说明schema
200OKResult
201Created
401Unauthorized
403Forbidden
404Not Found

用户注册

接口描述:

接口地址:/users

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"code": "",
	"password": "",
	"username": ""
}

请求参数

参数名称参数说明in是否必须数据类型schema
user用户注册bodytrueUserVOUserVO

schema属性说明

UserVO

参数名称参数说明in是否必须数据类型schema
code邮箱验证码bodytruestring
password密码bodytruestring
username用户名bodytruestring

响应示例:

{
	"code": 0,
	"data": {},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
flagboolean
messagestring

响应状态:

状态码说明schema
200OKResult
201Created
401Unauthorized
403Forbidden
404Not Found

发送邮箱验证码

接口描述:

接口地址:/users/code

请求方式GET

consumes:["application/json"]

produces:["*/*"]

请求示例

null

请求参数

参数名称参数说明in是否必须数据类型schema
username用户名bodytrueStringString

响应示例:

{
	"code": 0,
	"data": {},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
flagboolean
messagestring

响应状态:

状态码说明schema
200OKResult
401Unauthorized
403Forbidden
404Not Found

qq登录

接口描述:

接口地址:/users/oauth/qq

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称参数说明in是否必须数据类型schema
openIdopenIdbodytrueStringString
accessTokenaccessTokenbodytrueStringString

响应示例:

{
	"code": 0,
	"data": {
		"accountNonExpired": true,
		"accountNonLocked": true,
		"articleLikeSet": [],
		"authorities": {},
		"avatar": "",
		"browser": "",
		"commentLikeSet": [],
		"credentialsNonExpired": true,
		"email": "",
		"enabled": true,
		"id": 0,
		"intro": "",
		"ipAddr": "",
		"ipSource": "",
		"lastLoginTime": "",
		"loginType": 0,
		"nickname": "",
		"os": "",
		"password": "",
		"roleList": [],
		"userInfoId": 0,
		"username": "",
		"webSite": ""
	},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataUserInfoDTOUserInfoDTO
flagboolean
messagestring

schema属性说明

UserInfoDTO

参数名称参数说明类型schema
accountNonExpiredboolean
accountNonLockedboolean
articleLikeSetarray
authoritiesCollection«GrantedAuthority»Collection«GrantedAuthority»
avatarstring
browserstring
commentLikeSetarray
credentialsNonExpiredboolean
emailstring
enabledboolean
idinteger(int32)
introstring
ipAddrstring
ipSourcestring
lastLoginTimestring(date-time)
loginTypeinteger(int32)
nicknamestring
osstring
passwordstring
roleListarray
userInfoIdinteger(int32)
usernamestring
webSitestring

Collection«GrantedAuthority»

参数名称参数说明类型schema

响应状态:

状态码说明schema
200OKResult«UserInfoDTO»
201Created
401Unauthorized
403Forbidden
404Not Found

微博登录

接口描述:

接口地址:/users/oauth/weibo

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

null

请求参数

参数名称参数说明in是否必须数据类型schema
codecodebodytrueStringString

响应示例:

{
	"code": 0,
	"data": {
		"accountNonExpired": true,
		"accountNonLocked": true,
		"articleLikeSet": [],
		"authorities": {},
		"avatar": "",
		"browser": "",
		"commentLikeSet": [],
		"credentialsNonExpired": true,
		"email": "",
		"enabled": true,
		"id": 0,
		"intro": "",
		"ipAddr": "",
		"ipSource": "",
		"lastLoginTime": "",
		"loginType": 0,
		"nickname": "",
		"os": "",
		"password": "",
		"roleList": [],
		"userInfoId": 0,
		"username": "",
		"webSite": ""
	},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataUserInfoDTOUserInfoDTO
flagboolean
messagestring

schema属性说明

UserInfoDTO

参数名称参数说明类型schema
accountNonExpiredboolean
accountNonLockedboolean
articleLikeSetarray
authoritiesCollection«GrantedAuthority»Collection«GrantedAuthority»
avatarstring
browserstring
commentLikeSetarray
credentialsNonExpiredboolean
emailstring
enabledboolean
idinteger(int32)
introstring
ipAddrstring
ipSourcestring
lastLoginTimestring(date-time)
loginTypeinteger(int32)
nicknamestring
osstring
passwordstring
roleListarray
userInfoIdinteger(int32)
usernamestring
webSitestring

Collection«GrantedAuthority»

参数名称参数说明类型schema

响应状态:

状态码说明schema
200OKResult«UserInfoDTO»
201Created
401Unauthorized
403Forbidden
404Not Found

修改密码

接口描述:

接口地址:/users/password

请求方式PUT

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"code": "",
	"password": "",
	"username": ""
}

请求参数

参数名称参数说明in是否必须数据类型schema
user用户注册bodytrueUserVOUserVO

schema属性说明

UserVO

参数名称参数说明in是否必须数据类型schema
code邮箱验证码bodytruestring
password密码bodytruestring
username用户名bodytruestring

响应示例:

{
	"code": 0,
	"data": {},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
flagboolean
messagestring

响应状态:

状态码说明schema
200OKResult
201Created
401Unauthorized
403Forbidden
404Not Found

用户信息模块

修改用户禁用状态

接口描述:

接口地址:/admin/users/disable/{userInfoId}

请求方式PUT

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称参数说明in是否必须数据类型schema
userInfoIduserInfoIdpathtrueinteger
isDisableisDisablequeryfalseinteger

响应示例:

{
	"code": 0,
	"data": {},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
flagboolean
messagestring

响应状态:

状态码说明schema
200OKResult
201Created
401Unauthorized
403Forbidden
404Not Found

查看在线用户

接口描述:

接口地址:/admin/users/online

请求方式GET

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称参数说明in是否必须数据类型schema
categoryId分类idqueryfalseinteger
tagId标签idqueryfalseinteger
current当前页码querytrueinteger
size显示数量querytrueinteger
keywords搜索内容querytruestring
isDelete是否删除queryfalseinteger
isDraft草稿状态queryfalseinteger
startTime开始时间queryfalsestring
endTime结束时间queryfalsestring

响应示例:

{
	"code": 0,
	"data": {
		"count": 0,
		"recordList": [
			{
				"avatar": "",
				"browser": "",
				"ipAddr": "",
				"ipSource": "",
				"lastLoginTime": "",
				"nickname": "",
				"os": "",
				"userInfoId": 0
			}
		]
	},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataPageDTO«UserOnlineDTO»PageDTO«UserOnlineDTO»
flagboolean
messagestring

schema属性说明

PageDTO«UserOnlineDTO»

参数名称参数说明类型schema
countinteger(int32)
recordListarrayUserOnlineDTO

UserOnlineDTO

参数名称参数说明类型schema
avatarstring
browserstring
ipAddrstring
ipSourcestring
lastLoginTimestring(date-time)
nicknamestring
osstring
userInfoIdinteger(int32)

响应状态:

状态码说明schema
200OKResult«PageDTO«UserOnlineDTO»»
401Unauthorized
403Forbidden
404Not Found

下线用户

接口描述:

接口地址:/admin/users/online/{userInfoId}

请求方式DELETE

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称参数说明in是否必须数据类型schema
userInfoIduserInfoIdpathtrueinteger

响应示例:

{
	"code": 0,
	"data": {},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
flagboolean
messagestring

响应状态:

状态码说明schema
200OKResult
204No Content
401Unauthorized
403Forbidden

修改用户角色

接口描述:

接口地址:/admin/users/role

请求方式PUT

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"nickname": "",
	"roleIdList": [],
	"userInfoId": 0
}

请求参数

参数名称参数说明in是否必须数据类型schema
userRoleVO用户权限bodytrueUserRoleVOUserRoleVO

schema属性说明

UserRoleVO

参数名称参数说明in是否必须数据类型schema
nickname昵称bodyfalsestring
roleIdList角色id集合bodyfalsearray
userInfoId用户信息idbodyfalseinteger(int32)

响应示例:

{
	"code": 0,
	"data": "",
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
datastring
flagboolean
messagestring

响应状态:

状态码说明schema
200OKResult«string»
201Created
401Unauthorized
403Forbidden
404Not Found

修改用户头像

接口描述:

接口地址:/users/avatar

请求方式POST

consumes:["multipart/form-data"]

produces:["*/*"]

请求示例

null

请求参数

参数名称参数说明in是否必须数据类型schema
file用户头像bodytrueMultipartFileMultipartFile

响应示例:

{
	"code": 0,
	"data": "",
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
datastring
flagboolean
messagestring

响应状态:

状态码说明schema
200OKResult«string»
201Created
401Unauthorized
403Forbidden
404Not Found

绑定用户邮箱

接口描述:

接口地址:/users/email

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"code": "",
	"email": ""
}

请求参数

参数名称参数说明in是否必须数据类型schema
emailVO绑定邮箱bodytrueEmailVOEmailVO

schema属性说明

EmailVO

参数名称参数说明in是否必须数据类型schema
code邮箱验证码bodytruestring
email用户名bodytruestring

响应示例:

{
	"code": 0,
	"data": {},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
flagboolean
messagestring

响应状态:

状态码说明schema
200OKResult
201Created
401Unauthorized
403Forbidden
404Not Found

修改用户资料

接口描述:

接口地址:/users/info

请求方式PUT

consumes:["application/json"]

produces:["*/*"]

请求示例

{
	"intro": "",
	"nickname": "",
	"webSite": ""
}

请求参数

参数名称参数说明in是否必须数据类型schema
userInfoVO用户信息对象bodytrueUserInfoVOUserInfoVO

schema属性说明

UserInfoVO

参数名称参数说明in是否必须数据类型schema
intro介绍bodyfalsestring
nickname昵称bodyfalsestring
webSite个人网站bodyfalsestring

响应示例:

{
	"code": 0,
	"data": {},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
flagboolean
messagestring

响应状态:

状态码说明schema
200OKResult
201Created
401Unauthorized
403Forbidden
404Not Found

博客信息模块

查看博客信息

接口描述:

接口地址:/

请求方式GET

consumes:["application/json"]

produces:["*/*"]

请求参数: 暂无

响应示例:

{
	"code": 0,
	"data": {
		"articleCount": 0,
		"avatar": "",
		"categoryCount": 0,
		"intro": "",
		"nickname": "",
		"notice": "",
		"tagCount": 0,
		"viewsCount": ""
	},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataBlogHomeInfoDTOBlogHomeInfoDTO
flagboolean
messagestring

schema属性说明

BlogHomeInfoDTO

参数名称参数说明类型schema
articleCountinteger(int32)
avatarstring
categoryCountinteger(int32)
introstring
nicknamestring
noticestring
tagCountinteger(int32)
viewsCountstring

响应状态:

状态码说明schema
200OKResult«BlogHomeInfoDTO»
401Unauthorized
403Forbidden
404Not Found

查看关于我信息

接口描述:

接口地址:/about

请求方式GET

consumes:["application/json"]

produces:["*/*"]

请求参数: 暂无

响应示例:

{
	"code": 0,
	"data": "",
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
datastring
flagboolean
messagestring

响应状态:

状态码说明schema
200OKResult«string»
401Unauthorized
403Forbidden
404Not Found

查看后台信息

接口描述:

接口地址:/admin

请求方式GET

consumes:["application/json"]

produces:["*/*"]

请求参数: 暂无

响应示例:

{
	"code": 0,
	"data": {
		"articleCount": 0,
		"avatar": "",
		"categoryCount": 0,
		"intro": "",
		"nickname": "",
		"notice": "",
		"tagCount": 0,
		"viewsCount": ""
	},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataBlogHomeInfoDTOBlogHomeInfoDTO
flagboolean
messagestring

schema属性说明

BlogHomeInfoDTO

参数名称参数说明类型schema
articleCountinteger(int32)
avatarstring
categoryCountinteger(int32)
introstring
nicknamestring
noticestring
tagCountinteger(int32)
viewsCountstring

响应状态:

状态码说明schema
200OKResult«BlogHomeInfoDTO»
401Unauthorized
403Forbidden
404Not Found

修改关于我信息

接口描述:

接口地址:/admin/about

请求方式PUT

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称参数说明in是否必须数据类型schema
aboutContentaboutContentqueryfalsestring

响应示例:

{
	"code": 0,
	"data": {},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
flagboolean
messagestring

响应状态:

状态码说明schema
200OKResult
201Created
401Unauthorized
403Forbidden
404Not Found

查看公告

接口描述:

接口地址:/admin/notice

请求方式GET

consumes:["application/json"]

produces:["*/*"]

请求参数: 暂无

响应示例:

{
	"code": 0,
	"data": "",
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
datastring
flagboolean
messagestring

响应状态:

状态码说明schema
200OKResult«string»
401Unauthorized
403Forbidden
404Not Found

修改公告

接口描述:

接口地址:/admin/notice

请求方式PUT

consumes:["application/json"]

produces:["*/*"]

请求参数

参数名称参数说明in是否必须数据类型schema
noticenoticequeryfalsestring

响应示例:

{
	"code": 0,
	"data": {},
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
flagboolean
messagestring

响应状态:

状态码说明schema
200OKResult
201Created
401Unauthorized
403Forbidden
404Not Found

上传语音

接口描述:

接口地址:/voice

请求方式POST

consumes:["application/json"]

produces:["*/*"]

请求示例

null

请求参数

参数名称参数说明in是否必须数据类型schema
type消息类型querytrueinteger
userId用户idquerytrueinteger
nickname用户昵称querytruestring
avatar用户头像querytruestring
content聊天内容querytruestring
createTime创建时间querytruestring
ipAddr用户登录ipquerytruestring
ipSourceip来源querytruestring
file语音文件bodytrueMultipartFileMultipartFile

响应示例:

{
	"code": 0,
	"data": "",
	"flag": true,
	"message": ""
}

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
datastring
flagboolean
messagestring

响应状态:

状态码说明schema
200OKResult«string»
201Created
401Unauthorized
403Forbidden
404Not Found