私有接口文档

和合中国网后台管理系统

简介：

和合中国网后台管理系统的接口文档

HOST:localhost:8081

联系人:chasy

Version:1.0

接口路径：/v2/api-docs

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

文件

上传

接口描述:

接口地址:/admin/file/upload

请求方式：POST

consumes:["multipart/form-data"]

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
file	file	formData	true	file

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

文章

详情

接口描述:

接口地址:/admin/article

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	文章id	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found

新增

接口描述:

接口地址:/admin/article

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"collectionId": 0,
	"content": "",
	"createTime": "",
	"creator": "",
	"firstCategoryId": 0,
	"id": 0,
	"imgUrl": "",
	"orderNumber": 0,
	"pubStatus": 0,
	"remark": "",
	"secondCategoryId": 0,
	"sort": "",
	"status": 0,
	"title": "",
	"topicId": 0,
	"updateTime": "",
	"updater": "",
	"userId": 0
}

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
bo	bo	body	true	文章BO	文章BO

schema属性说明

文章BO

参数名称	参数说明	in	是否必须	数据类型	schema
collectionId	合集id	body	false	integer(int64)
content	内容	body	false	string
createTime	创建时间	body	false	string(date-time)
creator	创建人	body	false	string
firstCategoryId	1级分类id	body	false	integer(int64)
id	id	body	false	integer(int64)
imgUrl	图片地址	body	false	string
orderNumber	排序号	body	false	integer(int32)
pubStatus	发布状态（-1草稿箱、0仅我可见、1审核中、2已发布、3未通过）	body	false	integer(int32)
remark	备注	body	false	string
secondCategoryId	2级分类id	body	false	integer(int64)
sort	排序方式（如：createTime desc）	body	false	string
status	状态（-1删除、0禁用、1启用）	body	false	integer(int32)
title	标题	body	false	string
topicId	专题id	body	false	integer(int64)
updateTime	修改时间	body	false	string(date-time)
updater	修改人	body	false	string
userId	user表id	body	false	integer(int64)

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

更新

接口描述:

接口地址:/admin/article

请求方式：PUT

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"collectionId": 0,
	"content": "",
	"createTime": "",
	"creator": "",
	"firstCategoryId": 0,
	"id": 0,
	"imgUrl": "",
	"orderNumber": 0,
	"pubStatus": 0,
	"remark": "",
	"secondCategoryId": 0,
	"sort": "",
	"status": 0,
	"title": "",
	"topicId": 0,
	"updateTime": "",
	"updater": "",
	"userId": 0
}

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
bo	bo	body	true	文章BO	文章BO

schema属性说明

文章BO

参数名称	参数说明	in	是否必须	数据类型	schema
collectionId	合集id	body	false	integer(int64)
content	内容	body	false	string
createTime	创建时间	body	false	string(date-time)
creator	创建人	body	false	string
firstCategoryId	1级分类id	body	false	integer(int64)
id	id	body	false	integer(int64)
imgUrl	图片地址	body	false	string
orderNumber	排序号	body	false	integer(int32)
pubStatus	发布状态（-1草稿箱、0仅我可见、1审核中、2已发布、3未通过）	body	false	integer(int32)
remark	备注	body	false	string
secondCategoryId	2级分类id	body	false	integer(int64)
sort	排序方式（如：createTime desc）	body	false	string
status	状态（-1删除、0禁用、1启用）	body	false	integer(int32)
title	标题	body	false	string
topicId	专题id	body	false	integer(int64)
updateTime	修改时间	body	false	string(date-time)
updater	修改人	body	false	string
userId	user表id	body	false	integer(int64)

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

删除

接口描述:

接口地址:/admin/article

请求方式：DELETE

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	文章id	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
204	No Content
401	Unauthorized
403	Forbidden

审核

接口描述:

接口地址:/admin/article/check

请求方式：PUT

consumes:["application/json"]

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	文章id	query	false	string
pass	审核（1通过、0拒绝）	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

置顶

接口描述:

接口地址:/admin/article/highest

请求方式：PUT

consumes:["application/json"]

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	文章id	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

列表

接口描述:

接口地址:/admin/article/list

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
pageNum	页码	query	false	string
pageSize	数量	query	false	string
pubStatus	发布状态（-1草稿箱、0仅我可见、1审核中、2已发布、3未通过）	query	false	string
title	标题	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found

top10

接口描述:

接口地址:/admin/article/top10

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found

文章专题

详情

接口描述:

接口地址:/admin/articleTopic

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	专题id	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found

新增

接口描述:

接口地址:/admin/articleTopic

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"createTime": "",
	"creator": "",
	"id": 0,
	"imgUrl": "",
	"orderNumber": 0,
	"summary": "",
	"title": "",
	"updateTime": "",
	"updater": ""
}

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
bo	bo	body	true	文章专题BO	文章专题BO

schema属性说明

文章专题BO

参数名称	参数说明	in	是否必须	数据类型	schema
createTime	创建时间	body	false	string(date-time)
creator	创建人	body	false	string
id	id	body	false	integer(int64)
imgUrl	图片地址	body	false	string
orderNumber	排序号	body	false	integer(int32)
summary	摘要	body	false	string
title	标题	body	false	string
updateTime	修改时间	body	false	string(date-time)
updater	修改人	body	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

更新

接口描述:

接口地址:/admin/articleTopic

请求方式：PUT

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"createTime": "",
	"creator": "",
	"id": 0,
	"imgUrl": "",
	"orderNumber": 0,
	"summary": "",
	"title": "",
	"updateTime": "",
	"updater": ""
}

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
bo	bo	body	true	文章专题BO	文章专题BO

schema属性说明

文章专题BO

参数名称	参数说明	in	是否必须	数据类型	schema
createTime	创建时间	body	false	string(date-time)
creator	创建人	body	false	string
id	id	body	false	integer(int64)
imgUrl	图片地址	body	false	string
orderNumber	排序号	body	false	integer(int32)
summary	摘要	body	false	string
title	标题	body	false	string
updateTime	修改时间	body	false	string(date-time)
updater	修改人	body	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

删除

接口描述:

接口地址:/admin/articleTopic

请求方式：DELETE

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	专题id	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
204	No Content
401	Unauthorized
403	Forbidden

置顶

接口描述:

接口地址:/admin/articleTopic/highest

请求方式：PUT

consumes:["application/json"]

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	id	query	true	integer

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

列表

接口描述:

接口地址:/admin/articleTopic/list

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
pageNum	页码	query	false	string
pageSize	数量	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found

文章分类

详情

接口描述:

接口地址:/admin/articleCategory

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	分类id	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found

新增

接口描述:

接口地址:/admin/articleCategory

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"createTime": "",
	"creator": "",
	"id": 0,
	"level": 0,
	"name": "",
	"parentId": 0,
	"status": 0,
	"updateTime": "",
	"updater": ""
}

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
bo	bo	body	true	文章分类BO	文章分类BO

schema属性说明

文章分类BO

参数名称	参数说明	in	是否必须	数据类型	schema
createTime	创建时间	body	false	string(date-time)
creator	创建人	body	false	string
id	id	body	false	integer(int64)
level	分类等级	body	false	integer(int32)
name	名称	body	false	string
parentId	父级id	body	false	integer(int64)
status	状态（-1删除、0禁用、1启用）	body	false	integer(int32)
updateTime	修改时间	body	false	string(date-time)
updater	修改人	body	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

更新

接口描述:

接口地址:/admin/articleCategory

请求方式：PUT

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"createTime": "",
	"creator": "",
	"id": 0,
	"level": 0,
	"name": "",
	"parentId": 0,
	"status": 0,
	"updateTime": "",
	"updater": ""
}

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
bo	bo	body	true	文章分类BO	文章分类BO

schema属性说明

文章分类BO

参数名称	参数说明	in	是否必须	数据类型	schema
createTime	创建时间	body	false	string(date-time)
creator	创建人	body	false	string
id	id	body	false	integer(int64)
level	分类等级	body	false	integer(int32)
name	名称	body	false	string
parentId	父级id	body	false	integer(int64)
status	状态（-1删除、0禁用、1启用）	body	false	integer(int32)
updateTime	修改时间	body	false	string(date-time)
updater	修改人	body	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

删除

接口描述:

接口地址:/admin/articleCategory

请求方式：DELETE

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	分类id	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
204	No Content
401	Unauthorized
403	Forbidden

列表

接口描述:

接口地址:/admin/articleCategory/list

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
pageNum	页码	query	false	string
pageSize	数量	query	false	string
parentId	1级分类id（不传则默认查询1级分类列表）	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found

文章合集

详情

接口描述:

接口地址:/admin/articleCollection

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	合集id	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found

新增

接口描述:

接口地址:/admin/articleCollection

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"createTime": "",
	"creator": "",
	"id": 0,
	"imgUrl": "",
	"orderNumber": 0,
	"summary": "",
	"title": "",
	"updateTime": "",
	"updater": "",
	"userId": 0
}

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
bo	bo	body	true	文章合集BO	文章合集BO

schema属性说明

文章合集BO

参数名称	参数说明	in	是否必须	数据类型	schema
createTime	创建时间	body	false	string(date-time)
creator	创建人	body	false	string
id	id	body	false	integer(int64)
imgUrl	图片地址	body	false	string
orderNumber	排序号	body	false	integer(int32)
summary	摘要	body	false	string
title	标题	body	false	string
updateTime	修改时间	body	false	string(date-time)
updater	修改人	body	false	string
userId	user表id	body	false	integer(int64)

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

更新

接口描述:

接口地址:/admin/articleCollection

请求方式：PUT

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"createTime": "",
	"creator": "",
	"id": 0,
	"imgUrl": "",
	"orderNumber": 0,
	"summary": "",
	"title": "",
	"updateTime": "",
	"updater": "",
	"userId": 0
}

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
bo	bo	body	true	文章合集BO	文章合集BO

schema属性说明

文章合集BO

参数名称	参数说明	in	是否必须	数据类型	schema
createTime	创建时间	body	false	string(date-time)
creator	创建人	body	false	string
id	id	body	false	integer(int64)
imgUrl	图片地址	body	false	string
orderNumber	排序号	body	false	integer(int32)
summary	摘要	body	false	string
title	标题	body	false	string
updateTime	修改时间	body	false	string(date-time)
updater	修改人	body	false	string
userId	user表id	body	false	integer(int64)

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

删除

接口描述:

接口地址:/admin/articleCollection

请求方式：DELETE

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	合集id	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
204	No Content
401	Unauthorized
403	Forbidden

审核

接口描述:

接口地址:/admin/articleCollection/check

请求方式：PUT

consumes:["application/json"]

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	合集id	query	false	string
pass	审核（1通过、0拒绝）	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

置顶

接口描述:

接口地址:/admin/articleCollection/highest

请求方式：PUT

consumes:["application/json"]

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	合集id	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

列表

接口描述:

接口地址:/admin/articleCollection/list

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
pageNum	页码	query	false	string
pageSize	数量	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found

文章统计

详情

接口描述:

接口地址:/admin/articleStats

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	统计id	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found

新增

接口描述:

接口地址:/admin/articleStats

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"articleId": 0,
	"content": "",
	"createTime": "",
	"id": 0,
	"opType": 0,
	"userId": 0
}

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
bo	bo	body	true	文章统计BO	文章统计BO

schema属性说明

文章统计BO

参数名称	参数说明	in	是否必须	数据类型	schema
articleId	文章表id	body	false	integer(int64)
content	（评论）内容	body	false	string
createTime	创建时间	body	false	string(date-time)
id	id	body	false	integer(int64)
opType	操作类型（1评论、2点赞、3收藏、4转发、5查看）	body	false	integer(int32)
userId	user表id	body	false	integer(int64)

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

更新

接口描述:

接口地址:/admin/articleStats

请求方式：PUT

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"articleId": 0,
	"content": "",
	"createTime": "",
	"id": 0,
	"opType": 0,
	"userId": 0
}

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
bo	bo	body	true	文章统计BO	文章统计BO

schema属性说明

文章统计BO

参数名称	参数说明	in	是否必须	数据类型	schema
articleId	文章表id	body	false	integer(int64)
content	（评论）内容	body	false	string
createTime	创建时间	body	false	string(date-time)
id	id	body	false	integer(int64)
opType	操作类型（1评论、2点赞、3收藏、4转发、5查看）	body	false	integer(int32)
userId	user表id	body	false	integer(int64)

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

删除

接口描述:

接口地址:/admin/articleStats

请求方式：DELETE

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	统计id	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
204	No Content
401	Unauthorized
403	Forbidden

列表

接口描述:

接口地址:/admin/articleStats/list

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
opType	操作类型（1评论、2点赞、3收藏、4转发、5查看）	query	true	string
pageNum	页码	query	true	string
pageSize	数量	query	true	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found

版本日志

详情

接口描述:

接口地址:/admin/versionLog

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	id	query	true	integer

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found

列表

接口描述:

接口地址:/admin/versionLog/list

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found

用户管理

详情

接口描述:

接口地址:/admin/user

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	用户id	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found

新增

接口描述:

接口地址:/admin/user

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"authInfo": {
		"companyLeader": "",
		"companyLeaderIdCard": "",
		"companyLeaderIdCardImgBack": "",
		"companyLeaderIdCardImgFront": "",
		"companyLicenseImg": "",
		"companyName": "",
		"companyTaxId": "",
		"createTime": "",
		"idCard": "",
		"idCardImgBack": "",
		"idCardImgFront": "",
		"realName": "",
		"updateTime": "",
		"userId": 0
	},
	"authStatus": 0,
	"avatar": "",
	"countArticle": 0,
	"countCollection": 0,
	"createTime": "",
	"email": "",
	"id": 0,
	"loginTime": "",
	"nickname": "",
	"phone": "",
	"profile": "",
	"sex": 0,
	"status": 0,
	"type": 0
}

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
bo	bo	body	true	用户BO	用户BO

schema属性说明

用户BO

参数名称	参数说明	in	是否必须	数据类型	schema
authInfo	认证信息	body	false	用户认证信息VO	用户认证信息VO
authStatus	认证状态（0未认证、1审核中、2已认证、3已拒绝）	body	false	integer(int32)
avatar	头像	body	false	string
countArticle	发文数	body	false	integer(int32)
countCollection	合集数	body	false	integer(int32)
createTime	创建时间	body	false	string(date-time)
email	邮箱	body	false	string
id	id	body	false	integer(int64)
loginTime	最后登录时间	body	false	string(date-time)
nickname	昵称	body	false	string
phone	手机号	body	false	string
profile	简介	body	false	string
sex	性别	body	false	integer(int32)
status	状态（（-1删除、0禁用、1启用）	body	false	integer(int32)
type	类型	body	false	integer(int32)

用户认证信息VO

参数名称	参数说明	in	是否必须	数据类型	schema
companyLeader	公司法人	body	false	string
companyLeaderIdCard	公司法人身份证号	body	false	string
companyLeaderIdCardImgBack	公司法人身份证反面国徽图片地址	body	false	string
companyLeaderIdCardImgFront	公司法人身份证正面人像图片地址	body	false	string
companyLicenseImg	公司营业执照图片地址	body	false	string
companyName	公司名称	body	false	string
companyTaxId	公司税号	body	false	string
createTime	创建时间	body	false	string(date-time)
idCard	身份证号	body	false	string
idCardImgBack	身份证反面国徽图片地址	body	false	string
idCardImgFront	身份证正面人像图片地址	body	false	string
realName	真实姓名	body	false	string
updateTime	修改时间	body	false	string(date-time)
userId	user表id	body	false	integer(int64)

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

更新

接口描述:

接口地址:/admin/user

请求方式：PUT

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"authInfo": {
		"companyLeader": "",
		"companyLeaderIdCard": "",
		"companyLeaderIdCardImgBack": "",
		"companyLeaderIdCardImgFront": "",
		"companyLicenseImg": "",
		"companyName": "",
		"companyTaxId": "",
		"createTime": "",
		"idCard": "",
		"idCardImgBack": "",
		"idCardImgFront": "",
		"realName": "",
		"updateTime": "",
		"userId": 0
	},
	"authStatus": 0,
	"avatar": "",
	"countArticle": 0,
	"countCollection": 0,
	"createTime": "",
	"email": "",
	"id": 0,
	"loginTime": "",
	"nickname": "",
	"phone": "",
	"profile": "",
	"sex": 0,
	"status": 0,
	"type": 0
}

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
bo	bo	body	true	用户BO	用户BO

schema属性说明

用户BO

参数名称	参数说明	in	是否必须	数据类型	schema
authInfo	认证信息	body	false	用户认证信息VO	用户认证信息VO
authStatus	认证状态（0未认证、1审核中、2已认证、3已拒绝）	body	false	integer(int32)
avatar	头像	body	false	string
countArticle	发文数	body	false	integer(int32)
countCollection	合集数	body	false	integer(int32)
createTime	创建时间	body	false	string(date-time)
email	邮箱	body	false	string
id	id	body	false	integer(int64)
loginTime	最后登录时间	body	false	string(date-time)
nickname	昵称	body	false	string
phone	手机号	body	false	string
profile	简介	body	false	string
sex	性别	body	false	integer(int32)
status	状态（（-1删除、0禁用、1启用）	body	false	integer(int32)
type	类型	body	false	integer(int32)

用户认证信息VO

参数名称	参数说明	in	是否必须	数据类型	schema
companyLeader	公司法人	body	false	string
companyLeaderIdCard	公司法人身份证号	body	false	string
companyLeaderIdCardImgBack	公司法人身份证反面国徽图片地址	body	false	string
companyLeaderIdCardImgFront	公司法人身份证正面人像图片地址	body	false	string
companyLicenseImg	公司营业执照图片地址	body	false	string
companyName	公司名称	body	false	string
companyTaxId	公司税号	body	false	string
createTime	创建时间	body	false	string(date-time)
idCard	身份证号	body	false	string
idCardImgBack	身份证反面国徽图片地址	body	false	string
idCardImgFront	身份证正面人像图片地址	body	false	string
realName	真实姓名	body	false	string
updateTime	修改时间	body	false	string(date-time)
userId	user表id	body	false	integer(int64)

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

删除

接口描述:

接口地址:/admin/user

请求方式：DELETE

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	用户id	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
204	No Content
401	Unauthorized
403	Forbidden

审核

接口描述:

接口地址:/admin/user/check

请求方式：PUT

consumes:["application/json"]

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	用户id	query	false	string
pass	审核（1通过、0拒绝）	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

列表

接口描述:

接口地址:/admin/user/list

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
authStatus	认证状态（0未认证、1审核中、2已认证、3已拒绝）	query	false	string
type	用户类型（1普通用户、2企业用户、3内部用户）	query	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found

登录和重置密码

密码登录

接口描述:

接口地址:/admin/login

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"authType": 0,
	"captcha": "",
	"password": "",
	"resetPassword": "",
	"username": ""
}

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
bo	bo	body	true	登录请求参数	登录请求参数

schema属性说明

登录请求参数

参数名称	参数说明	in	是否必须	数据类型	schema
authType	（无需传入）	body	false	integer(int32)
captcha	验证码	body	false	string
password	密码	body	false	string
resetPassword	重复密码	body	false	string
username	登录名	body	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

重置密码

接口描述:

接口地址:/admin/reset

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"authType": 0,
	"captcha": "",
	"password": "",
	"resetPassword": "",
	"username": ""
}

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
req	req	body	true	登录请求参数	登录请求参数

schema属性说明

登录请求参数

参数名称	参数说明	in	是否必须	数据类型	schema
authType	（无需传入）	body	false	integer(int32)
captcha	验证码	body	false	string
password	密码	body	false	string
resetPassword	重复密码	body	false	string
username	登录名	body	false	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

系统日志

详情

接口描述:

接口地址:/admin/opLog

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
id	id	query	true	integer

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found

列表

接口描述:

接口地址:/admin/opLog/list

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
Authorization	需要登录时必传的jwt	header	false	string
pageNum	页码	query	true	string
pageSize	数量	query	true	string

响应示例:

{
	"code": 0,
	"data": {},
	"msg": ""
}

响应参数:

参数名称	参数说明	类型	schema
code	返回码	integer(int32)	integer(int32)
data	数据	object
msg	描述	string

响应状态:

状态码	说明	schema
200	OK	响应体
401	Unauthorized
403	Forbidden
404	Not Found