悦目图片管理系统 - API接口文档

简介:悦目图片管理系统 - API接口文档

联系邮箱:shengqiangwang666@gmail.com

Version:v1.0.0

接口路径:/v2/api-docs

activity-controller

addActivity

接口地址:/activity/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "content": "",
  "coverUrl": "",
  "expireTime": "",
  "spaceId": 0,
  "title": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
activityAddRequest	activityAddRequest	body	true	ActivityAddRequest	ActivityAddRequest
content			false	string
coverUrl			false	string
expireTime			false	string(date-time)
spaceId			false	integer(int64)
title			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

deleteActivity

接口地址:/activity/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getActivityById

接口地址:/activity/get

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Activity»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Activity	Activity
activityExpired	boolean
commentCount	integer(int64)
content	string
coverUrl	string
createTime	string(date-time)
expireTime	string(date-time)
id	integer(int64)
isDelete	integer(int32)
isExpired	integer(int32)
isLiked	integer(int32)
isShared	integer(int32)
likeCount	integer(int64)
reviewMessage	string
shareCount	integer(int64)
spaceId	integer(int64)
status	integer(int32)
title	string
updateTime	string(date-time)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"activityExpired": true,
		"commentCount": 0,
		"content": "",
		"coverUrl": "",
		"createTime": "",
		"expireTime": "",
		"id": 0,
		"isDelete": 0,
		"isExpired": 0,
		"isLiked": 0,
		"isShared": 0,
		"likeCount": 0,
		"reviewMessage": "",
		"shareCount": 0,
		"spaceId": 0,
		"status": 0,
		"title": "",
		"updateTime": "",
		"user": {
			"allowFollow": 0,
			"allowPrivateChat": 0,
			"createTime": "",
			"email": "",
			"fansCount": 0,
			"followCount": 0,
			"homepageBg": "",
			"id": 0,
			"showFansList": 0,
			"showFollowList": 0,
			"userAccount": "",
			"userAvatar": "",
			"userName": "",
			"userProfile": "",
			"userRole": ""
		},
		"userId": 0,
		"viewCount": 0
	},
	"message": ""
}

listCarouselActivities

接口地址:/activity/list/carousel

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "isPublic": true,
  "notExpired": true,
  "pageSize": 0,
  "searchText": "",
  "sortField": "",
  "sortOrder": "",
  "spaceId": 0,
  "status": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
activityQueryRequest	activityQueryRequest	body	true	ActivityQueryRequest	ActivityQueryRequest
current			false	integer(int32)
isPublic			false	boolean
notExpired			false	boolean
pageSize			false	integer(int32)
searchText			false	string
sortField			false	string
sortOrder			false	string
spaceId			false	integer(int64)
status			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«Activity»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«Activity»	Page«Activity»
current	integer(int64)
pages	integer(int64)
records	array	Activity
activityExpired	boolean
commentCount	integer
content	string
coverUrl	string
createTime	string
expireTime	string
id	integer
isDelete	integer
isExpired	integer
isLiked	integer
isShared	integer
likeCount	integer
reviewMessage	string
shareCount	integer
spaceId	integer
status	integer
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"activityExpired": true,
				"commentCount": 0,
				"content": "",
				"coverUrl": "",
				"createTime": "",
				"expireTime": "",
				"id": 0,
				"isDelete": 0,
				"isExpired": 0,
				"isLiked": 0,
				"isShared": 0,
				"likeCount": 0,
				"reviewMessage": "",
				"shareCount": 0,
				"spaceId": 0,
				"status": 0,
				"title": "",
				"updateTime": "",
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				},
				"userId": 0,
				"viewCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listActivityByPage

接口地址:/activity/list/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "isPublic": true,
  "notExpired": true,
  "pageSize": 0,
  "searchText": "",
  "sortField": "",
  "sortOrder": "",
  "spaceId": 0,
  "status": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
activityQueryRequest	activityQueryRequest	body	true	ActivityQueryRequest	ActivityQueryRequest
current			false	integer(int32)
isPublic			false	boolean
notExpired			false	boolean
pageSize			false	integer(int32)
searchText			false	string
sortField			false	string
sortOrder			false	string
spaceId			false	integer(int64)
status			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«Activity»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«Activity»	Page«Activity»
current	integer(int64)
pages	integer(int64)
records	array	Activity
activityExpired	boolean
commentCount	integer
content	string
coverUrl	string
createTime	string
expireTime	string
id	integer
isDelete	integer
isExpired	integer
isLiked	integer
isShared	integer
likeCount	integer
reviewMessage	string
shareCount	integer
spaceId	integer
status	integer
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"activityExpired": true,
				"commentCount": 0,
				"content": "",
				"coverUrl": "",
				"createTime": "",
				"expireTime": "",
				"id": 0,
				"isDelete": 0,
				"isExpired": 0,
				"isLiked": 0,
				"isShared": 0,
				"likeCount": 0,
				"reviewMessage": "",
				"shareCount": 0,
				"spaceId": 0,
				"status": 0,
				"title": "",
				"updateTime": "",
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				},
				"userId": 0,
				"viewCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listActivityBySpaceId

接口地址:/activity/list/page/space

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "isPublic": true,
  "notExpired": true,
  "pageSize": 0,
  "searchText": "",
  "sortField": "",
  "sortOrder": "",
  "spaceId": 0,
  "status": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
activityQueryRequest	activityQueryRequest	body	true	ActivityQueryRequest	ActivityQueryRequest
current			false	integer(int32)
isPublic			false	boolean
notExpired			false	boolean
pageSize			false	integer(int32)
searchText			false	string
sortField			false	string
sortOrder			false	string
spaceId			false	integer(int64)
status			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«Activity»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«Activity»	Page«Activity»
current	integer(int64)
pages	integer(int64)
records	array	Activity
activityExpired	boolean
commentCount	integer
content	string
coverUrl	string
createTime	string
expireTime	string
id	integer
isDelete	integer
isExpired	integer
isLiked	integer
isShared	integer
likeCount	integer
reviewMessage	string
shareCount	integer
spaceId	integer
status	integer
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"activityExpired": true,
				"commentCount": 0,
				"content": "",
				"coverUrl": "",
				"createTime": "",
				"expireTime": "",
				"id": 0,
				"isDelete": 0,
				"isExpired": 0,
				"isLiked": 0,
				"isShared": 0,
				"likeCount": 0,
				"reviewMessage": "",
				"shareCount": 0,
				"spaceId": 0,
				"status": 0,
				"title": "",
				"updateTime": "",
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				},
				"userId": 0,
				"viewCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

reviewActivity

接口地址:/activity/review

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
activityId	activityId	query	true	integer(int64)
status	status	query	true	integer(int32)
message	message	query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

ai-chat-controller

batchDeleteChat

接口地址:/deepseek/admin/delete/batch

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求示例:

javascript

[]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids	ids	body	true	array	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

listChatByPageAdmin

接口地址:/deepseek/admin/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
current	current	query	false	integer(int32)
pageSize	pageSize	query	false	integer(int32)
role	role	query	false	string
userId	userId	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«AiChat»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«AiChat»	Page«AiChat»
current	integer(int64)
pages	integer(int64)
records	array	AiChat
content	string
createTime	string
id	integer
isDeleted	integer
role	string
sessionId	integer
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"content": "",
				"createTime": "",
				"id": 0,
				"isDeleted": 0,
				"role": "",
				"sessionId": 0,
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

getChatHistory

接口地址:/deepseek/history

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
current	current	query	false	integer(int32)
pageSize	pageSize	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	Page«AiChatVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
current	integer(int64)	integer(int64)
pages	integer(int64)	integer(int64)
records	array	AiChatVO
content	string
createTime	string(date-time)
role	string
size	integer(int64)	integer(int64)
total	integer(int64)	integer(int64)

响应示例:

javascript

{
	"current": 0,
	"pages": 0,
	"records": [
		{
			"content": "",
			"createTime": "",
			"role": ""
		}
	],
	"size": 0,
	"total": 0
}

send

接口地址:/deepseek/send

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
query	query	query	false	string

响应状态:

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

响应参数:

暂无

响应示例:

javascript

app-controller

downloadApp

接口地址:/app/download

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

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

响应参数:

暂无

响应示例:

javascript

getVersionHistory

接口地址:/app/history

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
current	current	query	false	integer(int64)
pageSize	pageSize	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«AppVersion»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«AppVersion»	Page«AppVersion»
current	integer(int64)
pages	integer(int64)
records	array	AppVersion
apkPath	string
apkSize	integer
createTime	string
description	string
id	integer
isDelete	integer
isForce	integer
status	integer
updateTime	string
version	string
versionCode	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"apkPath": "",
				"apkSize": 0,
				"createTime": "",
				"description": "",
				"id": 0,
				"isDelete": 0,
				"isForce": 0,
				"status": 0,
				"updateTime": "",
				"version": "",
				"versionCode": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

uploadNewVersion

接口地址:/app/upload

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
appVersion	appVersion	query	true	string
file	file	formData	true	file

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getLatestVersion

接口地址:/app/version

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Map«string,object»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
message	string

响应示例:

javascript

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

audio-file-controller

batchDeleteAudio

接口地址:/audio/admin/delete/batch

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求示例:

javascript

[]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids	ids	body	true	array	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

listAudioByPageAdmin

接口地址:/audio/admin/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	请求类型	是否必须	数据类型
album	query	false	string
artist	query	false	string
current	query	false	integer(int32)
genre	query	false	string
pageSize	query	false	integer(int32)
sortField	query	false	string
sortOrder	query	false	string
spaceId	query	false	integer(int64)
title	query	false	string
userId	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«AudioFile»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«AudioFile»	Page«AudioFile»
current	integer(int64)
pages	integer(int64)
records	array	AudioFile
album	string
artist	string
coverUrl	string
createTime	string
description	string
duration	integer
fileName	string
filePath	string
fileSize	integer
fileUrl	string
genre	string
id	integer
isDelete	integer
likeCount	integer
md5	string
mimeType	string
spaceId	integer
title	string
updateTime	string
userId	integer
viewCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"album": "",
				"artist": "",
				"coverUrl": "",
				"createTime": "",
				"description": "",
				"duration": 0,
				"fileName": "",
				"filePath": "",
				"fileSize": 0,
				"fileUrl": "",
				"genre": "",
				"id": 0,
				"isDelete": 0,
				"likeCount": 0,
				"md5": "",
				"mimeType": "",
				"spaceId": 0,
				"title": "",
				"updateTime": "",
				"userId": 0,
				"viewCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listAudioByPage

接口地址:/audio/list/page

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	请求类型	是否必须	数据类型
album	query	false	string
artist	query	false	string
current	query	false	integer(int32)
genre	query	false	string
pageSize	query	false	integer(int32)
sortField	query	false	string
sortOrder	query	false	string
spaceId	query	false	integer(int64)
title	query	false	string
userId	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«AudioFileVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«AudioFileVO»	Page«AudioFileVO»
current	integer(int64)
pages	integer(int64)
records	array	AudioFileVO
album	string
artist	string
coverUrl	string
createTime	string
description	string
duration	integer
fileName	string
fileSize	integer
fileUrl	string
genre	string
id	integer
isLiked	integer
likeCount	integer
mimeType	string
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"album": "",
				"artist": "",
				"coverUrl": "",
				"createTime": "",
				"description": "",
				"duration": 0,
				"fileName": "",
				"fileSize": 0,
				"fileUrl": "",
				"genre": "",
				"id": 0,
				"isLiked": 0,
				"likeCount": 0,
				"mimeType": "",
				"title": "",
				"updateTime": "",
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				},
				"userId": 0,
				"viewCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

uploadAudio

接口地址:/audio/upload

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
file	音频文件	formData	true	file
album		query	false	string
artist		query	false	string
description		query	false	string
genre		query	false	string
spaceId		query	false	integer(int64)
title		query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«AudioFileVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	AudioFileVO	AudioFileVO
album	string
artist	string
coverUrl	string
createTime	string(date-time)
description	string
duration	integer(int32)
fileName	string
fileSize	integer(int64)
fileUrl	string
genre	string
id	integer(int64)
isLiked	integer(int32)
likeCount	integer(int64)
mimeType	string
title	string
updateTime	string(date-time)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"album": "",
		"artist": "",
		"coverUrl": "",
		"createTime": "",
		"description": "",
		"duration": 0,
		"fileName": "",
		"fileSize": 0,
		"fileUrl": "",
		"genre": "",
		"id": 0,
		"isLiked": 0,
		"likeCount": 0,
		"mimeType": "",
		"title": "",
		"updateTime": "",
		"user": {
			"allowFollow": 0,
			"allowPrivateChat": 0,
			"createTime": "",
			"email": "",
			"fansCount": 0,
			"followCount": 0,
			"homepageBg": "",
			"id": 0,
			"showFansList": 0,
			"showFollowList": 0,
			"userAccount": "",
			"userAvatar": "",
			"userName": "",
			"userProfile": "",
			"userRole": ""
		},
		"userId": 0,
		"viewCount": 0
	},
	"message": ""
}

getAudioById

接口地址:/audio/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«AudioFileVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	AudioFileVO	AudioFileVO
album	string
artist	string
coverUrl	string
createTime	string(date-time)
description	string
duration	integer(int32)
fileName	string
fileSize	integer(int64)
fileUrl	string
genre	string
id	integer(int64)
isLiked	integer(int32)
likeCount	integer(int64)
mimeType	string
title	string
updateTime	string(date-time)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"album": "",
		"artist": "",
		"coverUrl": "",
		"createTime": "",
		"description": "",
		"duration": 0,
		"fileName": "",
		"fileSize": 0,
		"fileUrl": "",
		"genre": "",
		"id": 0,
		"isLiked": 0,
		"likeCount": 0,
		"mimeType": "",
		"title": "",
		"updateTime": "",
		"user": {
			"allowFollow": 0,
			"allowPrivateChat": 0,
			"createTime": "",
			"email": "",
			"fansCount": 0,
			"followCount": 0,
			"homepageBg": "",
			"id": 0,
			"showFansList": 0,
			"showFollowList": 0,
			"userAccount": "",
			"userAvatar": "",
			"userName": "",
			"userProfile": "",
			"userRole": ""
		},
		"userId": 0,
		"viewCount": 0
	},
	"message": ""
}

deleteAudio

接口地址:/audio/{id}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	音频文件ID	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

bug-report-controller

addBugReport

接口地址:/bugReport/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "bugType": 0,
  "description": "",
  "screenshotUrls": "",
  "title": "",
  "websiteUrl": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
bugReportAddRequest	bugReportAddRequest	body	true	BugReportAddRequest	BugReportAddRequest
bugType			false	integer(int32)
description			false	string
screenshotUrls			false	string
title			false	string
websiteUrl			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

solveBugReport

接口地址:/bugReport/admin/solve

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	id	query	false	integer(int64)
resolution	resolution	query	false	string
status	status	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

deleteBugReport

接口地址:/bugReport/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "id": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deleteRequest	deleteRequest	body	true	DeleteRequest	DeleteRequest
id			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getBugReportById

接口地址:/bugReport/get

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«BugReportVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	BugReportVO	BugReportVO
bugType	integer(int32)
createTime	string(date-time)
description	string
id	integer(int64)
resolution	string
resolvedTime	string(date-time)
screenshotUrls	array	string
status	integer(int32)
title	string
updateTime	string(date-time)
userId	integer(int64)
userName	string
websiteUrl	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"bugType": 0,
		"createTime": "",
		"description": "",
		"id": 0,
		"resolution": "",
		"resolvedTime": "",
		"screenshotUrls": [],
		"status": 0,
		"title": "",
		"updateTime": "",
		"userId": 0,
		"userName": "",
		"websiteUrl": ""
	},
	"message": ""
}

listBugReportByPage

接口地址:/bugReport/list/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "bugType": 0,
  "current": 0,
  "id": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "status": 0,
  "title": "",
  "userId": 0,
  "websiteUrl": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
bugReportQueryRequest	bugReportQueryRequest	body	true	BugReportQueryRequest	BugReportQueryRequest
bugType			false	integer(int32)
current			false	integer(int32)
id			false	integer(int64)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
status			false	integer(int32)
title			false	string
userId			false	integer(int64)
websiteUrl			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«BugReportVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«BugReportVO»	Page«BugReportVO»
current	integer(int64)
pages	integer(int64)
records	array	BugReportVO
bugType	integer
createTime	string
description	string
id	integer
resolution	string
resolvedTime	string
screenshotUrls	array	string
status	integer
title	string
updateTime	string
userId	integer
userName	string
websiteUrl	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"bugType": 0,
				"createTime": "",
				"description": "",
				"id": 0,
				"resolution": "",
				"resolvedTime": "",
				"screenshotUrls": [],
				"status": 0,
				"title": "",
				"updateTime": "",
				"userId": 0,
				"userName": "",
				"websiteUrl": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listMyBugReportByPage

接口地址:/bugReport/my/list/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "bugType": 0,
  "current": 0,
  "id": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "status": 0,
  "title": "",
  "userId": 0,
  "websiteUrl": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
bugReportQueryRequest	bugReportQueryRequest	body	true	BugReportQueryRequest	BugReportQueryRequest
bugType			false	integer(int32)
current			false	integer(int32)
id			false	integer(int64)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
status			false	integer(int32)
title			false	string
userId			false	integer(int64)
websiteUrl			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«BugReportVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«BugReportVO»	Page«BugReportVO»
current	integer(int64)
pages	integer(int64)
records	array	BugReportVO
bugType	integer
createTime	string
description	string
id	integer
resolution	string
resolvedTime	string
screenshotUrls	array	string
status	integer
title	string
updateTime	string
userId	integer
userName	string
websiteUrl	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"bugType": 0,
				"createTime": "",
				"description": "",
				"id": 0,
				"resolution": "",
				"resolvedTime": "",
				"screenshotUrls": [],
				"status": 0,
				"title": "",
				"updateTime": "",
				"userId": 0,
				"userName": "",
				"websiteUrl": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

updateBugReport

接口地址:/bugReport/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "bugType": 0,
  "description": "",
  "id": 0,
  "screenshotUrls": "",
  "status": 0,
  "title": "",
  "websiteUrl": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
bugReportUpdateRequest	bugReportUpdateRequest	body	true	BugReportUpdateRequest	BugReportUpdateRequest
bugType			false	integer(int32)
description			false	string
id			false	integer(int64)
screenshotUrls			false	string
status			false	integer(int32)
title			false	string
websiteUrl			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

category-controller

addCategory

接口地址:/category/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
categoryName	categoryName	query	true	string
type	type	query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

deleteCategory

接口地址:/category/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
categoryId	categoryId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

listCategoryVO

接口地址:/category/list/page/vo

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
current		query	false	integer(int32)
pageSize		query	false	integer(int32)
sortField		query	false	string
sortOrder		query	false	string
type	type	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«CategoryVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«CategoryVO»	Page«CategoryVO»
current	integer(int64)
pages	integer(int64)
records	array	CategoryVO
categoryName	string
createTime	string
editTime	string
id	integer
type	integer
updateTime	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"categoryName": "",
				"createTime": "",
				"editTime": "",
				"id": 0,
				"type": 0,
				"updateTime": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listCategoryByType

接口地址:/category/list/type/{type}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
type	type	path	true	integer(int32)

响应状态:

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

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [],
	"message": ""
}

findCategory

接口地址:/category/search

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
categoryName	categoryName	query	true	string
type	type	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«CategoryVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	CategoryVO
categoryName	string
createTime	string(date-time)
editTime	string(date-time)
id	integer(int64)
type	integer(int32)
updateTime	string(date-time)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"categoryName": "",
			"createTime": "",
			"editTime": "",
			"id": 0,
			"type": 0,
			"updateTime": ""
		}
	],
	"message": ""
}

chat-message-controller

batchOperationMessages

接口地址:/chat/batch

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "ids": [],
  "operation": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
chatMessageBatchRequest	chatMessageBatchRequest	body	true	ChatMessageBatchRequest	ChatMessageBatchRequest
ids			false	array	integer(int64)
operation			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getMessageById

接口地址:/chat/get

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«ChatMessage»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	ChatMessage	ChatMessage
content	string
createTime	string(date-time)
id	integer(int64)
isDelete	integer(int32)
messageLocation	string
messageSize	integer(int64)
messageType	string
messageUrl	string
pictureId	integer(int64)
privateChatId	integer(int64)
receiverId	integer(int64)
replyId	integer(int64)
replyMessage	ChatMessage	ChatMessage
rootId	integer(int64)
sender	User	User
allowFollow	integer
allowMultiDeviceLogin	integer
allowPrivateChat	integer
birthday	string
createTime	string
editTime	string
email	string
gender	string
homepageBg	string
id	integer
interestField	string
isDelete	integer
lastActiveTime	string
personalSign	string
region	string
showFansList	integer
showFollowList	integer
themePreference	string
updateTime	string
userAccount	string
userAvatar	string
userName	string
userPassword	string
userProfile	string
userRole	string
userTags	string
visibilitySetting	string
senderId	integer(int64)
spaceId	integer(int64)
status	integer(int32)
type	integer(int32)
updateTime	string(date-time)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"content": "",
		"createTime": "",
		"id": 0,
		"isDelete": 0,
		"messageLocation": "",
		"messageSize": 0,
		"messageType": "",
		"messageUrl": "",
		"pictureId": 0,
		"privateChatId": 0,
		"receiverId": 0,
		"replyId": 0,
		"replyMessage": {
			"content": "",
			"createTime": "",
			"id": 0,
			"isDelete": 0,
			"messageLocation": "",
			"messageSize": 0,
			"messageType": "",
			"messageUrl": "",
			"pictureId": 0,
			"privateChatId": 0,
			"receiverId": 0,
			"replyId": 0,
			"replyMessage": {},
			"rootId": 0,
			"sender": {
				"allowFollow": 0,
				"allowMultiDeviceLogin": 0,
				"allowPrivateChat": 0,
				"birthday": "",
				"createTime": "",
				"editTime": "",
				"email": "",
				"gender": "",
				"homepageBg": "",
				"id": 0,
				"interestField": "",
				"isDelete": 0,
				"lastActiveTime": "",
				"personalSign": "",
				"region": "",
				"showFansList": 0,
				"showFollowList": 0,
				"themePreference": "",
				"updateTime": "",
				"userAccount": "",
				"userAvatar": "",
				"userName": "",
				"userPassword": "",
				"userProfile": "",
				"userRole": "",
				"userTags": "",
				"visibilitySetting": ""
			},
			"senderId": 0,
			"spaceId": 0,
			"status": 0,
			"type": 0,
			"updateTime": ""
		},
		"rootId": 0,
		"sender": {
			"allowFollow": 0,
			"allowMultiDeviceLogin": 0,
			"allowPrivateChat": 0,
			"birthday": "",
			"createTime": "",
			"editTime": "",
			"email": "",
			"gender": "",
			"homepageBg": "",
			"id": 0,
			"interestField": "",
			"isDelete": 0,
			"lastActiveTime": "",
			"personalSign": "",
			"region": "",
			"showFansList": 0,
			"showFollowList": 0,
			"themePreference": "",
			"updateTime": "",
			"userAccount": "",
			"userAvatar": "",
			"userName": "",
			"userPassword": "",
			"userProfile": "",
			"userRole": "",
			"userTags": "",
			"visibilitySetting": ""
		},
		"senderId": 0,
		"spaceId": 0,
		"status": 0,
		"type": 0,
		"updateTime": ""
	},
	"message": ""
}

listMessagesByPage

接口地址:/chat/list/page/admin

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "content": "",
  "current": 0,
  "id": 0,
  "pageSize": 0,
  "pictureId": 0,
  "privateChatId": 0,
  "receiverId": 0,
  "senderId": 0,
  "sortField": "",
  "sortOrder": "",
  "spaceId": 0,
  "status": 0,
  "type": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
chatMessageAdminRequest	chatMessageAdminRequest	body	true	ChatMessageAdminRequest	ChatMessageAdminRequest
content			false	string
current			false	integer(int32)
id			false	integer(int64)
pageSize			false	integer(int32)
pictureId			false	integer(int64)
privateChatId			false	integer(int64)
receiverId			false	integer(int64)
senderId			false	integer(int64)
sortField			false	string
sortOrder			false	string
spaceId			false	integer(int64)
status			false	integer(int32)
type			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«ChatMessage»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«ChatMessage»	Page«ChatMessage»
current	integer(int64)
pages	integer(int64)
records	array	ChatMessage
content	string
createTime	string
id	integer
isDelete	integer
messageLocation	string
messageSize	integer
messageType	string
messageUrl	string
pictureId	integer
privateChatId	integer
receiverId	integer
replyId	integer
replyMessage	ChatMessage	ChatMessage
rootId	integer
sender	User	User
allowFollow	integer
allowMultiDeviceLogin	integer
allowPrivateChat	integer
birthday	string
createTime	string
editTime	string
email	string
gender	string
homepageBg	string
id	integer
interestField	string
isDelete	integer
lastActiveTime	string
personalSign	string
region	string
showFansList	integer
showFollowList	integer
themePreference	string
updateTime	string
userAccount	string
userAvatar	string
userName	string
userPassword	string
userProfile	string
userRole	string
userTags	string
visibilitySetting	string
senderId	integer
spaceId	integer
status	integer
type	integer
updateTime	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"content": "",
				"createTime": "",
				"id": 0,
				"isDelete": 0,
				"messageLocation": "",
				"messageSize": 0,
				"messageType": "",
				"messageUrl": "",
				"pictureId": 0,
				"privateChatId": 0,
				"receiverId": 0,
				"replyId": 0,
				"replyMessage": {
					"content": "",
					"createTime": "",
					"id": 0,
					"isDelete": 0,
					"messageLocation": "",
					"messageSize": 0,
					"messageType": "",
					"messageUrl": "",
					"pictureId": 0,
					"privateChatId": 0,
					"receiverId": 0,
					"replyId": 0,
					"replyMessage": {},
					"rootId": 0,
					"sender": {
						"allowFollow": 0,
						"allowMultiDeviceLogin": 0,
						"allowPrivateChat": 0,
						"birthday": "",
						"createTime": "",
						"editTime": "",
						"email": "",
						"gender": "",
						"homepageBg": "",
						"id": 0,
						"interestField": "",
						"isDelete": 0,
						"lastActiveTime": "",
						"personalSign": "",
						"region": "",
						"showFansList": 0,
						"showFollowList": 0,
						"themePreference": "",
						"updateTime": "",
						"userAccount": "",
						"userAvatar": "",
						"userName": "",
						"userPassword": "",
						"userProfile": "",
						"userRole": "",
						"userTags": "",
						"visibilitySetting": ""
					},
					"senderId": 0,
					"spaceId": 0,
					"status": 0,
					"type": 0,
					"updateTime": ""
				},
				"rootId": 0,
				"sender": {
					"allowFollow": 0,
					"allowMultiDeviceLogin": 0,
					"allowPrivateChat": 0,
					"birthday": "",
					"createTime": "",
					"editTime": "",
					"email": "",
					"gender": "",
					"homepageBg": "",
					"id": 0,
					"interestField": "",
					"isDelete": 0,
					"lastActiveTime": "",
					"personalSign": "",
					"region": "",
					"showFansList": 0,
					"showFollowList": 0,
					"themePreference": "",
					"updateTime": "",
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userPassword": "",
					"userProfile": "",
					"userRole": "",
					"userTags": "",
					"visibilitySetting": ""
				},
				"senderId": 0,
				"spaceId": 0,
				"status": 0,
				"type": 0,
				"updateTime": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

updateMessage

接口地址:/chat/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "content": "",
  "createTime": "",
  "id": 0,
  "isDelete": 0,
  "messageLocation": "",
  "messageSize": 0,
  "messageType": "",
  "messageUrl": "",
  "pictureId": 0,
  "privateChatId": 0,
  "receiverId": 0,
  "replyId": 0,
  "replyMessage": {
    "content": "",
    "createTime": "",
    "id": 0,
    "isDelete": 0,
    "messageLocation": "",
    "messageSize": 0,
    "messageType": "",
    "messageUrl": "",
    "pictureId": 0,
    "privateChatId": 0,
    "receiverId": 0,
    "replyId": 0,
    "replyMessage": {
      "content": "",
      "createTime": "",
      "id": 0,
      "isDelete": 0,
      "messageLocation": "",
      "messageSize": 0,
      "messageType": "",
      "messageUrl": "",
      "pictureId": 0,
      "privateChatId": 0,
      "receiverId": 0,
      "replyId": 0,
      "replyMessage": {},
      "rootId": 0,
      "sender": {
        "allowFollow": 0,
        "allowMultiDeviceLogin": 0,
        "allowPrivateChat": 0,
        "birthday": "",
        "createTime": "",
        "editTime": "",
        "email": "",
        "gender": "",
        "homepageBg": "",
        "id": 0,
        "interestField": "",
        "isDelete": 0,
        "lastActiveTime": "",
        "personalSign": "",
        "region": "",
        "showFansList": 0,
        "showFollowList": 0,
        "themePreference": "",
        "updateTime": "",
        "userAccount": "",
        "userAvatar": "",
        "userName": "",
        "userPassword": "",
        "userProfile": "",
        "userRole": "",
        "userTags": "",
        "visibilitySetting": ""
      },
      "senderId": 0,
      "spaceId": 0,
      "status": 0,
      "type": 0,
      "updateTime": ""
    },
    "rootId": 0,
    "sender": {
      "allowFollow": 0,
      "allowMultiDeviceLogin": 0,
      "allowPrivateChat": 0,
      "birthday": "",
      "createTime": "",
      "editTime": "",
      "email": "",
      "gender": "",
      "homepageBg": "",
      "id": 0,
      "interestField": "",
      "isDelete": 0,
      "lastActiveTime": "",
      "personalSign": "",
      "region": "",
      "showFansList": 0,
      "showFollowList": 0,
      "themePreference": "",
      "updateTime": "",
      "userAccount": "",
      "userAvatar": "",
      "userName": "",
      "userPassword": "",
      "userProfile": "",
      "userRole": "",
      "userTags": "",
      "visibilitySetting": ""
    },
    "senderId": 0,
    "spaceId": 0,
    "status": 0,
    "type": 0,
    "updateTime": ""
  },
  "rootId": 0,
  "sender": {
    "allowFollow": 0,
    "allowMultiDeviceLogin": 0,
    "allowPrivateChat": 0,
    "birthday": "",
    "createTime": "",
    "editTime": "",
    "email": "",
    "gender": "",
    "homepageBg": "",
    "id": 0,
    "interestField": "",
    "isDelete": 0,
    "lastActiveTime": "",
    "personalSign": "",
    "region": "",
    "showFansList": 0,
    "showFollowList": 0,
    "themePreference": "",
    "updateTime": "",
    "userAccount": "",
    "userAvatar": "",
    "userName": "",
    "userPassword": "",
    "userProfile": "",
    "userRole": "",
    "userTags": "",
    "visibilitySetting": ""
  },
  "senderId": 0,
  "spaceId": 0,
  "status": 0,
  "type": 0,
  "updateTime": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
message	message	body	true	ChatMessage	ChatMessage
content			false	string
createTime			false	string(date-time)
id			false	integer(int64)
isDelete			false	integer(int32)
messageLocation			false	string
messageSize			false	integer(int64)
messageType			false	string
messageUrl			false	string
pictureId			false	integer(int64)
privateChatId			false	integer(int64)
receiverId			false	integer(int64)
replyId			false	integer(int64)
replyMessage			false	ChatMessage	ChatMessage
rootId			false	integer(int64)
sender			false	User	User
allowFollow			false	integer
allowMultiDeviceLogin			false	integer
allowPrivateChat			false	integer
birthday			false	string
createTime			false	string
editTime			false	string
email			false	string
gender			false	string
homepageBg			false	string
id			false	integer
interestField			false	string
isDelete			false	integer
lastActiveTime			false	string
personalSign			false	string
region			false	string
showFansList			false	integer
showFollowList			false	integer
themePreference			false	string
updateTime			false	string
userAccount			false	string
userAvatar			false	string
userName			false	string
userPassword			false	string
userProfile			false	string
userRole			false	string
userTags			false	string
visibilitySetting			false	string
senderId			false	integer(int64)
spaceId			false	integer(int64)
status			false	integer(int32)
type			false	integer(int32)
updateTime			false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

comments-controller

addComment

接口地址:/comments/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "content": "",
  "parentCommentId": 0,
  "targetId": 0,
  "targetType": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
commentsAddRequest	commentsAddRequest	body	true	CommentsAddRequest	CommentsAddRequest
content			false	string
parentCommentId			false	integer(int64)
targetId			false	integer(int64)
targetType			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

batchOperationComments

接口地址:/comments/batch

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "ids": [],
  "operation": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
commentsBatchRequest	commentsBatchRequest	body	true	CommentsBatchRequest	CommentsBatchRequest
ids			false	array	integer(int64)
operation			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getCommentedHistory

接口地址:/comments/commented/history

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "commentId": 0,
  "content": "",
  "current": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "targetId": 0,
  "targetType": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
commentsQueryRequest	commentsQueryRequest	body	true	CommentsQueryRequest	CommentsQueryRequest
commentId			false	integer(int64)
content			false	string
current			false	integer(int32)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
targetId			false	integer(int64)
targetType			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«CommentsVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«CommentsVO»	Page«CommentsVO»
current	integer(int64)
pages	integer(int64)
records	array	CommentsVO
children	array	CommentsVO
commentId	integer
commentUser	CommentUserVO	CommentUserVO
id	integer
userAccount	string
userAvatar	string
userName	string
content	string
createTime	string
current	integer
dislikeCount	integer
isRead	integer
likeCount	integer
location	string
pageSize	integer
parentId	integer
picture	PictureVO	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer
commentCount	integer
createTime	string
editTime	string
favoriteCount	integer
id	integer
introduction	string
isDownload	integer
isFavorited	integer
isFeature	integer
isLiked	integer
isShared	integer
likeCount	integer
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer
picScale	number
picSize	integer
picWidth	integer
recommendScore	number
reviewMessage	string
reviewStatus	integer
shareCount	integer
spaceId	integer
tags	array	string
thumbnailUrl	string
updateTime	string
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
post	Post	Post
allowCollect	integer
allowComment	integer
allowLike	integer
allowShare	integer
category	string
commentCount	integer
content	string
coverUrl	string
createTime	string
favoriteCount	integer
hotScore	number
id	integer
isDelete	integer
isDraft	integer
likeCount	integer
reviewMessage	string
shareCount	integer
status	integer
tags	string
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
sortField	string
sortOrder	string
targetId	integer
targetType	integer
targetUserId	integer
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"children": [
					{
						"children": [
							{}
						],
						"commentId": 0,
						"commentUser": {
							"id": 0,
							"userAccount": "",
							"userAvatar": "",
							"userName": ""
						},
						"content": "",
						"createTime": "",
						"current": 0,
						"dislikeCount": 0,
						"isRead": 0,
						"likeCount": 0,
						"location": "",
						"pageSize": 0,
						"parentId": 0,
						"picture": {
							"allowCollect": true,
							"allowComment": true,
							"allowLike": true,
							"allowShare": true,
							"category": "",
							"chatCount": 0,
							"commentCount": 0,
							"createTime": "",
							"editTime": "",
							"favoriteCount": 0,
							"id": 0,
							"introduction": "",
							"isDownload": 0,
							"isFavorited": 0,
							"isFeature": 0,
							"isLiked": 0,
							"isShared": 0,
							"likeCount": 0,
							"name": "",
							"permissionList": [],
							"picColor": "",
							"picFormat": "",
							"picHeight": 0,
							"picScale": 0,
							"picSize": 0,
							"picWidth": 0,
							"recommendScore": 0,
							"reviewMessage": "",
							"reviewStatus": 0,
							"shareCount": 0,
							"spaceId": 0,
							"tags": [],
							"thumbnailUrl": "",
							"updateTime": "",
							"url": "",
							"user": {
								"allowFollow": 0,
								"allowPrivateChat": 0,
								"createTime": "",
								"email": "",
								"fansCount": 0,
								"followCount": 0,
								"homepageBg": "",
								"id": 0,
								"showFansList": 0,
								"showFollowList": 0,
								"userAccount": "",
								"userAvatar": "",
								"userName": "",
								"userProfile": "",
								"userRole": ""
							},
							"userId": 0,
							"viewCount": 0
						},
						"post": {
							"allowCollect": 0,
							"allowComment": 0,
							"allowLike": 0,
							"allowShare": 0,
							"category": "",
							"commentCount": 0,
							"content": "",
							"coverUrl": "",
							"createTime": "",
							"favoriteCount": 0,
							"hotScore": 0,
							"id": 0,
							"isDelete": 0,
							"isDraft": 0,
							"likeCount": 0,
							"reviewMessage": "",
							"shareCount": 0,
							"status": 0,
							"tags": "",
							"title": "",
							"updateTime": "",
							"user": {
								"allowFollow": 0,
								"allowPrivateChat": 0,
								"createTime": "",
								"email": "",
								"fansCount": 0,
								"followCount": 0,
								"homepageBg": "",
								"id": 0,
								"showFansList": 0,
								"showFollowList": 0,
								"userAccount": "",
								"userAvatar": "",
								"userName": "",
								"userProfile": "",
								"userRole": ""
							},
							"userId": 0,
							"viewCount": 0
						},
						"sortField": "",
						"sortOrder": "",
						"targetId": 0,
						"targetType": 0,
						"targetUserId": 0,
						"userId": 0
					}
				],
				"commentId": 0,
				"commentUser": {
					"id": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": ""
				},
				"content": "",
				"createTime": "",
				"current": 0,
				"dislikeCount": 0,
				"isRead": 0,
				"likeCount": 0,
				"location": "",
				"pageSize": 0,
				"parentId": 0,
				"picture": {},
				"post": {},
				"sortField": "",
				"sortOrder": "",
				"targetId": 0,
				"targetType": 0,
				"targetUserId": 0,
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

deleteComment

接口地址:/comments/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "commentId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
commentsDeleteRequest	commentsDeleteRequest	body	true	CommentsDeleteRequest	CommentsDeleteRequest
commentId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getCommentById

接口地址:/comments/get

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Comments»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Comments	Comments
commentId	integer(int64)
content	string
createTime	string(date-time)
dislikeCount	integer(int64)
isDelete	integer(int32)
isRead	integer(int32)
likeCount	integer(int64)
location	string
parentCommentId	integer(int64)
rootCommentId	integer(int64)
targetId	integer(int64)
targetType	integer(int32)
targetUserId	integer(int64)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"commentId": 0,
		"content": "",
		"createTime": "",
		"dislikeCount": 0,
		"isDelete": 0,
		"isRead": 0,
		"likeCount": 0,
		"location": "",
		"parentCommentId": 0,
		"rootCommentId": 0,
		"targetId": 0,
		"targetType": 0,
		"targetUserId": 0,
		"userId": 0
	},
	"message": ""
}

likeComment

接口地址:/comments/like

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "commentId": 0,
  "dislikeCount": 0,
  "likeCount": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
commentslikeRequest	commentslikeRequest	body	true	CommentsLikeRequest	CommentsLikeRequest
commentId			false	integer(int64)
dislikeCount			false	integer(int64)
likeCount			false	integer(int64)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

listCommentsByPage

接口地址:/comments/list/page/admin

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "commentId": 0,
  "content": "",
  "current": 0,
  "isDelete": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "targetId": 0,
  "targetType": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
commentsAdminRequest	commentsAdminRequest	body	true	CommentsAdminRequest	CommentsAdminRequest
commentId			false	integer(int64)
content			false	string
current			false	integer(int32)
isDelete			false	integer(int32)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
targetId			false	integer(int64)
targetType			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«Comments»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«Comments»	Page«Comments»
current	integer(int64)
pages	integer(int64)
records	array	Comments
commentId	integer
content	string
createTime	string
dislikeCount	integer
isDelete	integer
isRead	integer
likeCount	integer
location	string
parentCommentId	integer
rootCommentId	integer
targetId	integer
targetType	integer
targetUserId	integer
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"commentId": 0,
				"content": "",
				"createTime": "",
				"dislikeCount": 0,
				"isDelete": 0,
				"isRead": 0,
				"likeCount": 0,
				"location": "",
				"parentCommentId": 0,
				"rootCommentId": 0,
				"targetId": 0,
				"targetType": 0,
				"targetUserId": 0,
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

getMyCommentHistory

接口地址:/comments/my/history

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "commentId": 0,
  "content": "",
  "current": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "targetId": 0,
  "targetType": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
commentsQueryRequest	commentsQueryRequest	body	true	CommentsQueryRequest	CommentsQueryRequest
commentId			false	integer(int64)
content			false	string
current			false	integer(int32)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
targetId			false	integer(int64)
targetType			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«CommentsVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«CommentsVO»	Page«CommentsVO»
current	integer(int64)
pages	integer(int64)
records	array	CommentsVO
children	array	CommentsVO
commentId	integer
commentUser	CommentUserVO	CommentUserVO
id	integer
userAccount	string
userAvatar	string
userName	string
content	string
createTime	string
current	integer
dislikeCount	integer
isRead	integer
likeCount	integer
location	string
pageSize	integer
parentId	integer
picture	PictureVO	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer
commentCount	integer
createTime	string
editTime	string
favoriteCount	integer
id	integer
introduction	string
isDownload	integer
isFavorited	integer
isFeature	integer
isLiked	integer
isShared	integer
likeCount	integer
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer
picScale	number
picSize	integer
picWidth	integer
recommendScore	number
reviewMessage	string
reviewStatus	integer
shareCount	integer
spaceId	integer
tags	array	string
thumbnailUrl	string
updateTime	string
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
post	Post	Post
allowCollect	integer
allowComment	integer
allowLike	integer
allowShare	integer
category	string
commentCount	integer
content	string
coverUrl	string
createTime	string
favoriteCount	integer
hotScore	number
id	integer
isDelete	integer
isDraft	integer
likeCount	integer
reviewMessage	string
shareCount	integer
status	integer
tags	string
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
sortField	string
sortOrder	string
targetId	integer
targetType	integer
targetUserId	integer
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"children": [
					{
						"children": [
							{}
						],
						"commentId": 0,
						"commentUser": {
							"id": 0,
							"userAccount": "",
							"userAvatar": "",
							"userName": ""
						},
						"content": "",
						"createTime": "",
						"current": 0,
						"dislikeCount": 0,
						"isRead": 0,
						"likeCount": 0,
						"location": "",
						"pageSize": 0,
						"parentId": 0,
						"picture": {
							"allowCollect": true,
							"allowComment": true,
							"allowLike": true,
							"allowShare": true,
							"category": "",
							"chatCount": 0,
							"commentCount": 0,
							"createTime": "",
							"editTime": "",
							"favoriteCount": 0,
							"id": 0,
							"introduction": "",
							"isDownload": 0,
							"isFavorited": 0,
							"isFeature": 0,
							"isLiked": 0,
							"isShared": 0,
							"likeCount": 0,
							"name": "",
							"permissionList": [],
							"picColor": "",
							"picFormat": "",
							"picHeight": 0,
							"picScale": 0,
							"picSize": 0,
							"picWidth": 0,
							"recommendScore": 0,
							"reviewMessage": "",
							"reviewStatus": 0,
							"shareCount": 0,
							"spaceId": 0,
							"tags": [],
							"thumbnailUrl": "",
							"updateTime": "",
							"url": "",
							"user": {
								"allowFollow": 0,
								"allowPrivateChat": 0,
								"createTime": "",
								"email": "",
								"fansCount": 0,
								"followCount": 0,
								"homepageBg": "",
								"id": 0,
								"showFansList": 0,
								"showFollowList": 0,
								"userAccount": "",
								"userAvatar": "",
								"userName": "",
								"userProfile": "",
								"userRole": ""
							},
							"userId": 0,
							"viewCount": 0
						},
						"post": {
							"allowCollect": 0,
							"allowComment": 0,
							"allowLike": 0,
							"allowShare": 0,
							"category": "",
							"commentCount": 0,
							"content": "",
							"coverUrl": "",
							"createTime": "",
							"favoriteCount": 0,
							"hotScore": 0,
							"id": 0,
							"isDelete": 0,
							"isDraft": 0,
							"likeCount": 0,
							"reviewMessage": "",
							"shareCount": 0,
							"status": 0,
							"tags": "",
							"title": "",
							"updateTime": "",
							"user": {
								"allowFollow": 0,
								"allowPrivateChat": 0,
								"createTime": "",
								"email": "",
								"fansCount": 0,
								"followCount": 0,
								"homepageBg": "",
								"id": 0,
								"showFansList": 0,
								"showFollowList": 0,
								"userAccount": "",
								"userAvatar": "",
								"userName": "",
								"userProfile": "",
								"userRole": ""
							},
							"userId": 0,
							"viewCount": 0
						},
						"sortField": "",
						"sortOrder": "",
						"targetId": 0,
						"targetType": 0,
						"targetUserId": 0,
						"userId": 0
					}
				],
				"commentId": 0,
				"commentUser": {
					"id": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": ""
				},
				"content": "",
				"createTime": "",
				"current": 0,
				"dislikeCount": 0,
				"isRead": 0,
				"likeCount": 0,
				"location": "",
				"pageSize": 0,
				"parentId": 0,
				"picture": {},
				"post": {},
				"sortField": "",
				"sortOrder": "",
				"targetId": 0,
				"targetType": 0,
				"targetUserId": 0,
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

queryComment

接口地址:/comments/query

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "commentId": 0,
  "content": "",
  "current": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "targetId": 0,
  "targetType": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
commentsQueryRequest	commentsQueryRequest	body	true	CommentsQueryRequest	CommentsQueryRequest
commentId			false	integer(int64)
content			false	string
current			false	integer(int32)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
targetId			false	integer(int64)
targetType			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«CommentsVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«CommentsVO»	Page«CommentsVO»
current	integer(int64)
pages	integer(int64)
records	array	CommentsVO
children	array	CommentsVO
commentId	integer
commentUser	CommentUserVO	CommentUserVO
id	integer
userAccount	string
userAvatar	string
userName	string
content	string
createTime	string
current	integer
dislikeCount	integer
isRead	integer
likeCount	integer
location	string
pageSize	integer
parentId	integer
picture	PictureVO	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer
commentCount	integer
createTime	string
editTime	string
favoriteCount	integer
id	integer
introduction	string
isDownload	integer
isFavorited	integer
isFeature	integer
isLiked	integer
isShared	integer
likeCount	integer
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer
picScale	number
picSize	integer
picWidth	integer
recommendScore	number
reviewMessage	string
reviewStatus	integer
shareCount	integer
spaceId	integer
tags	array	string
thumbnailUrl	string
updateTime	string
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
post	Post	Post
allowCollect	integer
allowComment	integer
allowLike	integer
allowShare	integer
category	string
commentCount	integer
content	string
coverUrl	string
createTime	string
favoriteCount	integer
hotScore	number
id	integer
isDelete	integer
isDraft	integer
likeCount	integer
reviewMessage	string
shareCount	integer
status	integer
tags	string
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
sortField	string
sortOrder	string
targetId	integer
targetType	integer
targetUserId	integer
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"children": [
					{
						"children": [
							{}
						],
						"commentId": 0,
						"commentUser": {
							"id": 0,
							"userAccount": "",
							"userAvatar": "",
							"userName": ""
						},
						"content": "",
						"createTime": "",
						"current": 0,
						"dislikeCount": 0,
						"isRead": 0,
						"likeCount": 0,
						"location": "",
						"pageSize": 0,
						"parentId": 0,
						"picture": {
							"allowCollect": true,
							"allowComment": true,
							"allowLike": true,
							"allowShare": true,
							"category": "",
							"chatCount": 0,
							"commentCount": 0,
							"createTime": "",
							"editTime": "",
							"favoriteCount": 0,
							"id": 0,
							"introduction": "",
							"isDownload": 0,
							"isFavorited": 0,
							"isFeature": 0,
							"isLiked": 0,
							"isShared": 0,
							"likeCount": 0,
							"name": "",
							"permissionList": [],
							"picColor": "",
							"picFormat": "",
							"picHeight": 0,
							"picScale": 0,
							"picSize": 0,
							"picWidth": 0,
							"recommendScore": 0,
							"reviewMessage": "",
							"reviewStatus": 0,
							"shareCount": 0,
							"spaceId": 0,
							"tags": [],
							"thumbnailUrl": "",
							"updateTime": "",
							"url": "",
							"user": {
								"allowFollow": 0,
								"allowPrivateChat": 0,
								"createTime": "",
								"email": "",
								"fansCount": 0,
								"followCount": 0,
								"homepageBg": "",
								"id": 0,
								"showFansList": 0,
								"showFollowList": 0,
								"userAccount": "",
								"userAvatar": "",
								"userName": "",
								"userProfile": "",
								"userRole": ""
							},
							"userId": 0,
							"viewCount": 0
						},
						"post": {
							"allowCollect": 0,
							"allowComment": 0,
							"allowLike": 0,
							"allowShare": 0,
							"category": "",
							"commentCount": 0,
							"content": "",
							"coverUrl": "",
							"createTime": "",
							"favoriteCount": 0,
							"hotScore": 0,
							"id": 0,
							"isDelete": 0,
							"isDraft": 0,
							"likeCount": 0,
							"reviewMessage": "",
							"shareCount": 0,
							"status": 0,
							"tags": "",
							"title": "",
							"updateTime": "",
							"user": {
								"allowFollow": 0,
								"allowPrivateChat": 0,
								"createTime": "",
								"email": "",
								"fansCount": 0,
								"followCount": 0,
								"homepageBg": "",
								"id": 0,
								"showFansList": 0,
								"showFollowList": 0,
								"userAccount": "",
								"userAvatar": "",
								"userName": "",
								"userProfile": "",
								"userRole": ""
							},
							"userId": 0,
							"viewCount": 0
						},
						"sortField": "",
						"sortOrder": "",
						"targetId": 0,
						"targetType": 0,
						"targetUserId": 0,
						"userId": 0
					}
				],
				"commentId": 0,
				"commentUser": {
					"id": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": ""
				},
				"content": "",
				"createTime": "",
				"current": 0,
				"dislikeCount": 0,
				"isRead": 0,
				"likeCount": 0,
				"location": "",
				"pageSize": 0,
				"parentId": 0,
				"picture": {},
				"post": {},
				"sortField": "",
				"sortOrder": "",
				"targetId": 0,
				"targetType": 0,
				"targetUserId": 0,
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

getUnreadComments

接口地址:/comments/unread

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«CommentsVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	CommentsVO
children	array	CommentsVO
commentId	integer(int64)
commentUser	CommentUserVO	CommentUserVO
id	integer
userAccount	string
userAvatar	string
userName	string
content	string
createTime	string(date-time)
current	integer(int32)
dislikeCount	integer(int64)
isRead	integer(int32)
likeCount	integer(int64)
location	string
pageSize	integer(int32)
parentId	integer(int64)
picture	PictureVO	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer
commentCount	integer
createTime	string
editTime	string
favoriteCount	integer
id	integer
introduction	string
isDownload	integer
isFavorited	integer
isFeature	integer
isLiked	integer
isShared	integer
likeCount	integer
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer
picScale	number
picSize	integer
picWidth	integer
recommendScore	number
reviewMessage	string
reviewStatus	integer
shareCount	integer
spaceId	integer
tags	array	string
thumbnailUrl	string
updateTime	string
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
post	Post	Post
allowCollect	integer
allowComment	integer
allowLike	integer
allowShare	integer
category	string
commentCount	integer
content	string
coverUrl	string
createTime	string
favoriteCount	integer
hotScore	number
id	integer
isDelete	integer
isDraft	integer
likeCount	integer
reviewMessage	string
shareCount	integer
status	integer
tags	string
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
sortField	string
sortOrder	string
targetId	integer(int64)
targetType	integer(int32)
targetUserId	integer(int64)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"children": [
				{
					"children": [
						{}
					],
					"commentId": 0,
					"commentUser": {
						"id": 0,
						"userAccount": "",
						"userAvatar": "",
						"userName": ""
					},
					"content": "",
					"createTime": "",
					"current": 0,
					"dislikeCount": 0,
					"isRead": 0,
					"likeCount": 0,
					"location": "",
					"pageSize": 0,
					"parentId": 0,
					"picture": {
						"allowCollect": true,
						"allowComment": true,
						"allowLike": true,
						"allowShare": true,
						"category": "",
						"chatCount": 0,
						"commentCount": 0,
						"createTime": "",
						"editTime": "",
						"favoriteCount": 0,
						"id": 0,
						"introduction": "",
						"isDownload": 0,
						"isFavorited": 0,
						"isFeature": 0,
						"isLiked": 0,
						"isShared": 0,
						"likeCount": 0,
						"name": "",
						"permissionList": [],
						"picColor": "",
						"picFormat": "",
						"picHeight": 0,
						"picScale": 0,
						"picSize": 0,
						"picWidth": 0,
						"recommendScore": 0,
						"reviewMessage": "",
						"reviewStatus": 0,
						"shareCount": 0,
						"spaceId": 0,
						"tags": [],
						"thumbnailUrl": "",
						"updateTime": "",
						"url": "",
						"user": {
							"allowFollow": 0,
							"allowPrivateChat": 0,
							"createTime": "",
							"email": "",
							"fansCount": 0,
							"followCount": 0,
							"homepageBg": "",
							"id": 0,
							"showFansList": 0,
							"showFollowList": 0,
							"userAccount": "",
							"userAvatar": "",
							"userName": "",
							"userProfile": "",
							"userRole": ""
						},
						"userId": 0,
						"viewCount": 0
					},
					"post": {
						"allowCollect": 0,
						"allowComment": 0,
						"allowLike": 0,
						"allowShare": 0,
						"category": "",
						"commentCount": 0,
						"content": "",
						"coverUrl": "",
						"createTime": "",
						"favoriteCount": 0,
						"hotScore": 0,
						"id": 0,
						"isDelete": 0,
						"isDraft": 0,
						"likeCount": 0,
						"reviewMessage": "",
						"shareCount": 0,
						"status": 0,
						"tags": "",
						"title": "",
						"updateTime": "",
						"user": {
							"allowFollow": 0,
							"allowPrivateChat": 0,
							"createTime": "",
							"email": "",
							"fansCount": 0,
							"followCount": 0,
							"homepageBg": "",
							"id": 0,
							"showFansList": 0,
							"showFollowList": 0,
							"userAccount": "",
							"userAvatar": "",
							"userName": "",
							"userProfile": "",
							"userRole": ""
						},
						"userId": 0,
						"viewCount": 0
					},
					"sortField": "",
					"sortOrder": "",
					"targetId": 0,
					"targetType": 0,
					"targetUserId": 0,
					"userId": 0
				}
			],
			"commentId": 0,
			"commentUser": {
				"id": 0,
				"userAccount": "",
				"userAvatar": "",
				"userName": ""
			},
			"content": "",
			"createTime": "",
			"current": 0,
			"dislikeCount": 0,
			"isRead": 0,
			"likeCount": 0,
			"location": "",
			"pageSize": 0,
			"parentId": 0,
			"picture": {},
			"post": {},
			"sortField": "",
			"sortOrder": "",
			"targetId": 0,
			"targetType": 0,
			"targetUserId": 0,
			"userId": 0
		}
	],
	"message": ""
}

getUnreadCommentsCount

接口地址:/comments/unread/count

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

updateComment

接口地址:/comments/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "commentId": 0,
  "content": "",
  "createTime": "",
  "dislikeCount": 0,
  "isDelete": 0,
  "isRead": 0,
  "likeCount": 0,
  "location": "",
  "parentCommentId": 0,
  "rootCommentId": 0,
  "targetId": 0,
  "targetType": 0,
  "targetUserId": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
comment	comment	body	true	Comments	Comments
commentId			false	integer(int64)
content			false	string
createTime			false	string(date-time)
dislikeCount			false	integer(int64)
isDelete			false	integer(int32)
isRead			false	integer(int32)
likeCount			false	integer(int64)
location			false	string
parentCommentId			false	integer(int64)
rootCommentId			false	integer(int64)
targetId			false	integer(int64)
targetType			false	integer(int32)
targetUserId			false	integer(int64)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

dashboard-controller

getChartStats

接口地址:/dashboard/charts

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«ChartVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	ChartVO	ChartVO
areaChartData	AreaChartData	AreaChartData
series	array	Map«string,object»
additionalProperty1	Map«string,object»	Map«string,object»
xaxisData	array	string
pieChartData	PieChartData	PieChartData
labels	array	string
values	array	integer
radarChartData	RadarChartData	RadarChartData
data	array	Map«string,object»
additionalProperty1	Map«string,object»	Map«string,object»
indicator	array	string
stackedBarChartData	StackedBarChartData	StackedBarChartData
series	array	Map«string,object»
additionalProperty1	Map«string,object»	Map«string,object»
xaxisData	array	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"areaChartData": {
			"series": [
				{}
			],
			"xaxisData": []
		},
		"pieChartData": {
			"labels": [],
			"values": []
		},
		"radarChartData": {
			"data": [
				{}
			],
			"indicator": []
		},
		"stackedBarChartData": {
			"series": [
				{}
			],
			"xaxisData": []
		}
	},
	"message": ""
}

getDashboardStats

接口地址:/dashboard/stats

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«DashboardVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	DashboardVO	DashboardVO
newActivities	integer(int64)
newAudioFiles	integer(int64)
newBugReports	integer(int64)
newChatMessages	integer(int64)
newFriendLinks	integer(int64)
newLoveBoards	integer(int64)
newMessages	integer(int64)
newPictures	integer(int64)
newPosts	integer(int64)
newReports	integer(int64)
newSpaces	integer(int64)
newUsers	integer(int64)
totalBugReports	integer(int64)
totalViews	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"newActivities": 0,
		"newAudioFiles": 0,
		"newBugReports": 0,
		"newChatMessages": 0,
		"newFriendLinks": 0,
		"newLoveBoards": 0,
		"newMessages": 0,
		"newPictures": 0,
		"newPosts": 0,
		"newReports": 0,
		"newSpaces": 0,
		"newUsers": 0,
		"totalBugReports": 0,
		"totalViews": 0
	},
	"message": ""
}

favorite-record-controller

addFavoriteRecord

接口地址:/favorite-record/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "isFavorite": true,
  "targetId": 0,
  "targetType": 0,
  "targetUserId": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
favoriteRecordAddRequest	favoriteRecordAddRequest	body	true	FavoriteRecordAddRequest	FavoriteRecordAddRequest
isFavorite			false	boolean
targetId			false	integer(int64)
targetType			false	integer(int32)
targetUserId			false	integer(int64)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

cancelFavorite

接口地址:/favorite-record/cancel

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
targetId	targetId	query	true	integer(int64)
targetType	targetType	query	true	integer(int32)
userId	userId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

checkHasFavorited

接口地址:/favorite-record/check

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
targetId	targetId	query	true	integer(int64)
targetType	targetType	query	true	integer(int32)
userId	userId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getFavoriteHistory

接口地址:/favorite-record/history

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "isFavorite": true,
  "isRead": true,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "targetId": 0,
  "targetType": 0,
  "targetUserId": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
favoriteQueryRequest	favoriteQueryRequest	body	true	FavoriteRecordQueryRequest	FavoriteRecordQueryRequest
current			false	integer(int32)
isFavorite			false	boolean
isRead			false	boolean
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
targetId			false	integer(int64)
targetType			false	integer(int32)
targetUserId			false	integer(int64)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«FavoriteRecordVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«FavoriteRecordVO»	Page«FavoriteRecordVO»
current	integer(int64)
pages	integer(int64)
records	array	FavoriteRecordVO
id	integer
isRead	integer
lastFavoriteTime	string
target	object
targetType	integer
targetUserId	integer
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"id": 0,
				"isRead": 0,
				"lastFavoriteTime": "",
				"target": {},
				"targetType": 0,
				"targetUserId": 0,
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				}
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

getMyFavoriteHistory

接口地址:/favorite-record/my/history

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "isFavorite": true,
  "isRead": true,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "targetId": 0,
  "targetType": 0,
  "targetUserId": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
favoriteQueryRequest	favoriteQueryRequest	body	true	FavoriteRecordQueryRequest	FavoriteRecordQueryRequest
current			false	integer(int32)
isFavorite			false	boolean
isRead			false	boolean
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
targetId			false	integer(int64)
targetType			false	integer(int32)
targetUserId			false	integer(int64)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«FavoriteRecordVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«FavoriteRecordVO»	Page«FavoriteRecordVO»
current	integer(int64)
pages	integer(int64)
records	array	FavoriteRecordVO
id	integer
isRead	integer
lastFavoriteTime	string
target	object
targetType	integer
targetUserId	integer
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"id": 0,
				"isRead": 0,
				"lastFavoriteTime": "",
				"target": {},
				"targetType": 0,
				"targetUserId": 0,
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				}
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

getUnreadFavorites

接口地址:/favorite-record/unread

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«FavoriteRecordVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	FavoriteRecordVO
id	integer(int64)
isRead	integer(int32)
lastFavoriteTime	string(date-time)
target	object
targetType	integer(int32)
targetUserId	integer(int64)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"id": 0,
			"isRead": 0,
			"lastFavoriteTime": "",
			"target": {},
			"targetType": 0,
			"targetUserId": 0,
			"user": {
				"allowFollow": 0,
				"allowPrivateChat": 0,
				"createTime": "",
				"email": "",
				"fansCount": 0,
				"followCount": 0,
				"homepageBg": "",
				"id": 0,
				"showFansList": 0,
				"showFollowList": 0,
				"userAccount": "",
				"userAvatar": "",
				"userName": "",
				"userProfile": "",
				"userRole": ""
			}
		}
	],
	"message": ""
}

getUnreadFavoritesCount

接口地址:/favorite-record/unread/count

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

file-controller

testDownloadFile

接口地址:/file/test/download/

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
filepath	filepath	query	false	string

响应状态:

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

响应参数:

暂无

响应示例:

javascript

testUploadFile

接口地址:/file/test/upload

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
file	file	formData	true	file

响应状态:

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

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	string
message	string

响应示例:

javascript

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

file-upload-controller

commonUploadAudio

接口地址:/file/upload/audio

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
artist	艺术家	query	false	string
description	音频描述	query	false	string
file	音频文件	formData	false	file
tags	标签	query	false	string
title	音频标题	query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«AudioFileVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	AudioFileVO	AudioFileVO
album	string
artist	string
coverUrl	string
createTime	string(date-time)
description	string
duration	integer(int32)
fileName	string
fileSize	integer(int64)
fileUrl	string
genre	string
id	integer(int64)
isLiked	integer(int32)
likeCount	integer(int64)
mimeType	string
title	string
updateTime	string(date-time)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"album": "",
		"artist": "",
		"coverUrl": "",
		"createTime": "",
		"description": "",
		"duration": 0,
		"fileName": "",
		"fileSize": 0,
		"fileUrl": "",
		"genre": "",
		"id": 0,
		"isLiked": 0,
		"likeCount": 0,
		"mimeType": "",
		"title": "",
		"updateTime": "",
		"user": {
			"allowFollow": 0,
			"allowPrivateChat": 0,
			"createTime": "",
			"email": "",
			"fansCount": 0,
			"followCount": 0,
			"homepageBg": "",
			"id": 0,
			"showFansList": 0,
			"showFollowList": 0,
			"userAccount": "",
			"userAvatar": "",
			"userName": "",
			"userProfile": "",
			"userRole": ""
		},
		"userId": 0,
		"viewCount": 0
	},
	"message": ""
}

commonUploadPicture

接口地址:/file/upload/picture

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
description	图片描述	query	false	string
file	图片文件	formData	false	file
name	图片名称	query	false	string
tags	标签	query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«PictureVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	PictureVO	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer(int64)
commentCount	integer(int64)
createTime	string(date-time)
editTime	string(date-time)
favoriteCount	integer(int64)
id	integer(int64)
introduction	string
isDownload	integer(int32)
isFavorited	integer(int32)
isFeature	integer(int32)
isLiked	integer(int32)
isShared	integer(int32)
likeCount	integer(int64)
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer(int32)
picScale	number(double)
picSize	integer(int64)
picWidth	integer(int32)
recommendScore	number(double)
reviewMessage	string
reviewStatus	integer(int32)
shareCount	integer(int64)
spaceId	integer(int64)
tags	array	string
thumbnailUrl	string
updateTime	string(date-time)
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"allowCollect": true,
		"allowComment": true,
		"allowLike": true,
		"allowShare": true,
		"category": "",
		"chatCount": 0,
		"commentCount": 0,
		"createTime": "",
		"editTime": "",
		"favoriteCount": 0,
		"id": 0,
		"introduction": "",
		"isDownload": 0,
		"isFavorited": 0,
		"isFeature": 0,
		"isLiked": 0,
		"isShared": 0,
		"likeCount": 0,
		"name": "",
		"permissionList": [],
		"picColor": "",
		"picFormat": "",
		"picHeight": 0,
		"picScale": 0,
		"picSize": 0,
		"picWidth": 0,
		"recommendScore": 0,
		"reviewMessage": "",
		"reviewStatus": 0,
		"shareCount": 0,
		"spaceId": 0,
		"tags": [],
		"thumbnailUrl": "",
		"updateTime": "",
		"url": "",
		"user": {
			"allowFollow": 0,
			"allowPrivateChat": 0,
			"createTime": "",
			"email": "",
			"fansCount": 0,
			"followCount": 0,
			"homepageBg": "",
			"id": 0,
			"showFansList": 0,
			"showFollowList": 0,
			"userAccount": "",
			"userAvatar": "",
			"userName": "",
			"userProfile": "",
			"userRole": ""
		},
		"userId": 0,
		"viewCount": 0
	},
	"message": ""
}

addFriendLink

接口地址:/friend-link/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "clickCount": 0,
  "createTime": "",
  "id": 0,
  "isDelete": 0,
  "ownerContact": "",
  "ownerName": "",
  "reviewMessage": "",
  "siteDesc": "",
  "siteLogo": "",
  "siteName": "",
  "siteType": "",
  "siteUrl": "",
  "status": 0,
  "updateTime": "",
  "userId": 0,
  "viewCount": 0,
  "weight": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
friendLink	friendLink	body	true	FriendLink	FriendLink
clickCount			false	integer(int64)
createTime			false	string(date-time)
id			false	integer(int64)
isDelete			false	integer(int32)
ownerContact			false	string
ownerName			false	string
reviewMessage			false	string
siteDesc			false	string
siteLogo			false	string
siteName			false	string
siteType			false	string
siteUrl			false	string
status			false	integer(int32)
updateTime			false	string(date-time)
userId			false	integer(int64)
viewCount			false	integer(int64)
weight			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

increaseClickCount

接口地址:/friend-link/click/{id}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

countByType

接口地址:/friend-link/count/type

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
siteType	siteType	query	true	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

deleteFriendLink

接口地址:/friend-link/delete/{id}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getFriendLinkById

接口地址:/friend-link/get/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«FriendLink»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	FriendLink	FriendLink
clickCount	integer(int64)
createTime	string(date-time)
id	integer(int64)
isDelete	integer(int32)
ownerContact	string
ownerName	string
reviewMessage	string
siteDesc	string
siteLogo	string
siteName	string
siteType	string
siteUrl	string
status	integer(int32)
updateTime	string(date-time)
userId	integer(int64)
viewCount	integer(int64)
weight	integer(int32)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"clickCount": 0,
		"createTime": "",
		"id": 0,
		"isDelete": 0,
		"ownerContact": "",
		"ownerName": "",
		"reviewMessage": "",
		"siteDesc": "",
		"siteLogo": "",
		"siteName": "",
		"siteType": "",
		"siteUrl": "",
		"status": 0,
		"updateTime": "",
		"userId": 0,
		"viewCount": 0,
		"weight": 0
	},
	"message": ""
}

listFriendLinksByPage

接口地址:/friend-link/list/page

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	请求类型	是否必须	数据类型
current	query	false	integer(int32)
pageSize	query	false	integer(int32)
siteName	query	false	string
siteType	query	false	string
sortField	query	false	string
sortOrder	query	false	string
status	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«FriendLink»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«FriendLink»	Page«FriendLink»
current	integer(int64)
pages	integer(int64)
records	array	FriendLink
clickCount	integer
createTime	string
id	integer
isDelete	integer
ownerContact	string
ownerName	string
reviewMessage	string
siteDesc	string
siteLogo	string
siteName	string
siteType	string
siteUrl	string
status	integer
updateTime	string
userId	integer
viewCount	integer
weight	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"clickCount": 0,
				"createTime": "",
				"id": 0,
				"isDelete": 0,
				"ownerContact": "",
				"ownerName": "",
				"reviewMessage": "",
				"siteDesc": "",
				"siteLogo": "",
				"siteName": "",
				"siteType": "",
				"siteUrl": "",
				"status": 0,
				"updateTime": "",
				"userId": 0,
				"viewCount": 0,
				"weight": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listRecommendFriendLinks

接口地址:/friend-link/recommend

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
limit	limit	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«FriendLink»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	FriendLink
clickCount	integer(int64)
createTime	string(date-time)
id	integer(int64)
isDelete	integer(int32)
ownerContact	string
ownerName	string
reviewMessage	string
siteDesc	string
siteLogo	string
siteName	string
siteType	string
siteUrl	string
status	integer(int32)
updateTime	string(date-time)
userId	integer(int64)
viewCount	integer(int64)
weight	integer(int32)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"clickCount": 0,
			"createTime": "",
			"id": 0,
			"isDelete": 0,
			"ownerContact": "",
			"ownerName": "",
			"reviewMessage": "",
			"siteDesc": "",
			"siteLogo": "",
			"siteName": "",
			"siteType": "",
			"siteUrl": "",
			"status": 0,
			"updateTime": "",
			"userId": 0,
			"viewCount": 0,
			"weight": 0
		}
	],
	"message": ""
}

refreshCache

接口地址:/friend-link/refresh-cache

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

reviewFriendLink

接口地址:/friend-link/review/{id}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	id	path	true	integer(int64)
status	status	query	true	integer(int32)
reviewMessage	reviewMessage	query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

listSiteTypes

接口地址:/friend-link/site-types

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«Map«string,string»»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	Map«string,string»
additionalProperty1	Map«string,string»	Map«string,string»
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{}
	],
	"message": ""
}

updateFriendLink

接口地址:/friend-link/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "clickCount": 0,
  "createTime": "",
  "id": 0,
  "isDelete": 0,
  "ownerContact": "",
  "ownerName": "",
  "reviewMessage": "",
  "siteDesc": "",
  "siteLogo": "",
  "siteName": "",
  "siteType": "",
  "siteUrl": "",
  "status": 0,
  "updateTime": "",
  "userId": 0,
  "viewCount": 0,
  "weight": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
friendLink	friendLink	body	true	FriendLink	FriendLink
clickCount			false	integer(int64)
createTime			false	string(date-time)
id			false	integer(int64)
isDelete			false	integer(int32)
ownerContact			false	string
ownerName			false	string
reviewMessage			false	string
siteDesc			false	string
siteLogo			false	string
siteName			false	string
siteType			false	string
siteUrl			false	string
status			false	integer(int32)
updateTime			false	string(date-time)
userId			false	integer(int64)
viewCount			false	integer(int64)
weight			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

updateWeight

接口地址:/friend-link/weight/{id}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)
weight	weight	query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

game-2048-controller

getUserHighestScore

接口地址:/game2048/highest

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«int»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int32)	integer(int32)
message	string

响应示例:

javascript

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

getUserGameHistory

接口地址:/game2048/history

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
current	current	query	false	integer(int32)
pageSize	pageSize	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Map«string,object»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
message	string

响应示例:

javascript

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

getRankingList

接口地址:/game2048/ranking

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
limit	limit	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«Game2048RecordVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	Game2048RecordVO
createTime	string(date-time)
gameTime	integer(int32)
maxTile	integer(int32)
moveCount	integer(int32)
score	integer(int32)
userAvatar	string
userId	integer(int64)
userName	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"createTime": "",
			"gameTime": 0,
			"maxTile": 0,
			"moveCount": 0,
			"score": 0,
			"userAvatar": "",
			"userId": 0,
			"userName": ""
		}
	],
	"message": ""
}

saveGame2048Record

接口地址:/game2048/save

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "gameTime": 0,
  "maxTile": 0,
  "moveCount": 0,
  "score": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
request	request	body	true	SaveGameRecordRequest	SaveGameRecordRequest
gameTime			false	integer(int32)
maxTile			false	integer(int32)
moveCount			false	integer(int32)
score			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Game2048Record»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Game2048Record	Game2048Record
createTime	string(date-time)
gameTime	integer(int32)
id	integer(int64)
isDelete	integer(int32)
maxTile	integer(int32)
moveCount	integer(int32)
score	integer(int32)
updateTime	string(date-time)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"createTime": "",
		"gameTime": 0,
		"id": 0,
		"isDelete": 0,
		"maxTile": 0,
		"moveCount": 0,
		"score": 0,
		"updateTime": "",
		"userId": 0
	},
	"message": ""
}

like-record-controller

batchOperationLikes

接口地址:/like/batch

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "ids": [],
  "operation": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
likeBatchRequest	likeBatchRequest	body	true	LikeBatchRequest	LikeBatchRequest
ids			false	array	integer(int64)
operation			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

doLike

接口地址:/like/do

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "isLiked": true,
  "targetId": 0,
  "targetType": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
likeRequest	likeRequest	body	true	LikeRequest	LikeRequest
isLiked			false	boolean
targetId			false	integer(int64)
targetType			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getLikeById

接口地址:/like/get/admin

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«LikeRecord»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	LikeRecord	LikeRecord
firstLikeTime	string(date-time)
id	integer(int64)
isLiked	boolean
isRead	integer(int32)
lastLikeTime	string(date-time)
targetId	integer(int64)
targetType	integer(int32)
targetUserId	integer(int64)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"firstLikeTime": "",
		"id": 0,
		"isLiked": true,
		"isRead": 0,
		"lastLikeTime": "",
		"targetId": 0,
		"targetType": 0,
		"targetUserId": 0,
		"userId": 0
	},
	"message": ""
}

getLikeHistory

接口地址:/like/history

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "targetType": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
likeQueryRequest	likeQueryRequest	body	true	LikeQueryRequest	LikeQueryRequest
current			false	integer(int32)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
targetType			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«LikeRecordVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«LikeRecordVO»	Page«LikeRecordVO»
current	integer(int64)
pages	integer(int64)
records	array	LikeRecordVO
id	integer
isRead	integer
lastLikeTime	string
target	object
targetType	integer
targetUserId	integer
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"id": 0,
				"isRead": 0,
				"lastLikeTime": "",
				"target": {},
				"targetType": 0,
				"targetUserId": 0,
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				}
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listLikesByPage

接口地址:/like/list/page/admin

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "id": 0,
  "isLiked": true,
  "isRead": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "targetId": 0,
  "targetType": 0,
  "targetUserId": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
likeAdminRequest	likeAdminRequest	body	true	LikeAdminRequest	LikeAdminRequest
current			false	integer(int32)
id			false	integer(int64)
isLiked			false	boolean
isRead			false	integer(int32)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
targetId			false	integer(int64)
targetType			false	integer(int32)
targetUserId			false	integer(int64)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«LikeRecord»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«LikeRecord»	Page«LikeRecord»
current	integer(int64)
pages	integer(int64)
records	array	LikeRecord
firstLikeTime	string
id	integer
isLiked	boolean
isRead	integer
lastLikeTime	string
targetId	integer
targetType	integer
targetUserId	integer
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"firstLikeTime": "",
				"id": 0,
				"isLiked": true,
				"isRead": 0,
				"lastLikeTime": "",
				"targetId": 0,
				"targetType": 0,
				"targetUserId": 0,
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

getMyLikeHistory

接口地址:/like/my/history

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "targetType": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
likeQueryRequest	likeQueryRequest	body	true	LikeQueryRequest	LikeQueryRequest
current			false	integer(int32)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
targetType			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«LikeRecordVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«LikeRecordVO»	Page«LikeRecordVO»
current	integer(int64)
pages	integer(int64)
records	array	LikeRecordVO
id	integer
isRead	integer
lastLikeTime	string
target	object
targetType	integer
targetUserId	integer
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"id": 0,
				"isRead": 0,
				"lastLikeTime": "",
				"target": {},
				"targetType": 0,
				"targetUserId": 0,
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				}
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

getLikeStatus

接口地址:/like/status/{targetType}/{targetId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
targetId	targetId	path	true	integer(int64)
targetType	targetType	path	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getUnreadLikes

接口地址:/like/unread

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«LikeRecordVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	LikeRecordVO
id	integer(int64)
isRead	integer(int32)
lastLikeTime	string(date-time)
target	object
targetType	integer(int32)
targetUserId	integer(int64)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"id": 0,
			"isRead": 0,
			"lastLikeTime": "",
			"target": {},
			"targetType": 0,
			"targetUserId": 0,
			"user": {
				"allowFollow": 0,
				"allowPrivateChat": 0,
				"createTime": "",
				"email": "",
				"fansCount": 0,
				"followCount": 0,
				"homepageBg": "",
				"id": 0,
				"showFansList": 0,
				"showFollowList": 0,
				"userAccount": "",
				"userAvatar": "",
				"userName": "",
				"userProfile": "",
				"userRole": ""
			}
		}
	],
	"message": ""
}

getUnreadLikesCount

接口地址:/like/unread/count

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

updateLike

接口地址:/like/update/admin

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "firstLikeTime": "",
  "id": 0,
  "isLiked": true,
  "isRead": 0,
  "lastLikeTime": "",
  "targetId": 0,
  "targetType": 0,
  "targetUserId": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
like	like	body	true	LikeRecord	LikeRecord
firstLikeTime			false	string(date-time)
id			false	integer(int64)
isLiked			false	boolean
isRead			false	integer(int32)
lastLikeTime			false	string(date-time)
targetId			false	integer(int64)
targetType			false	integer(int32)
targetUserId			false	integer(int64)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

love-board-controller

addLoveBoard

接口地址:/love-board/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "bgCover": "",
  "countdownTime": "",
  "countdownTitle": "",
  "createTime": "",
  "familyInfo": "",
  "id": 0,
  "isDelete": 0,
  "likeCount": 0,
  "manCover": "",
  "manName": "",
  "status": 0,
  "timing": "",
  "updateTime": "",
  "userId": 0,
  "viewCount": 0,
  "womanCover": "",
  "womanName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
loveBoard	loveBoard	body	true	LoveBoard	LoveBoard
bgCover			false	string
countdownTime			false	string
countdownTitle			false	string
createTime			false	string(date-time)
familyInfo			false	string
id			false	integer(int64)
isDelete			false	integer(int32)
likeCount			false	integer(int64)
manCover			false	string
manName			false	string
status			false	integer(int32)
timing			false	string
updateTime			false	string(date-time)
userId			false	integer(int64)
viewCount			false	integer(int64)
womanCover			false	string
womanName			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

batchOperationLoveBoards

接口地址:/love-board/batch

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "ids": [],
  "operation": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
loveBoardBatchRequest	loveBoardBatchRequest	body	true	LoveBoardBatchRequest	LoveBoardBatchRequest
ids			false	array	integer(int64)
operation			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

deleteLoveBoard

接口地址:/love-board/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getLoveBoardById

接口地址:/love-board/get

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«LoveBoard»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	LoveBoard	LoveBoard
bgCover	string
countdownTime	string
countdownTitle	string
createTime	string(date-time)
familyInfo	string
id	integer(int64)
isDelete	integer(int32)
likeCount	integer(int64)
manCover	string
manName	string
status	integer(int32)
timing	string
updateTime	string(date-time)
userId	integer(int64)
viewCount	integer(int64)
womanCover	string
womanName	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"bgCover": "",
		"countdownTime": "",
		"countdownTitle": "",
		"createTime": "",
		"familyInfo": "",
		"id": 0,
		"isDelete": 0,
		"likeCount": 0,
		"manCover": "",
		"manName": "",
		"status": 0,
		"timing": "",
		"updateTime": "",
		"userId": 0,
		"viewCount": 0,
		"womanCover": "",
		"womanName": ""
	},
	"message": ""
}

getLoveBoardByIdAdmin

接口地址:/love-board/get/admin

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«LoveBoard»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	LoveBoard	LoveBoard
bgCover	string
countdownTime	string
countdownTitle	string
createTime	string(date-time)
familyInfo	string
id	integer(int64)
isDelete	integer(int32)
likeCount	integer(int64)
manCover	string
manName	string
status	integer(int32)
timing	string
updateTime	string(date-time)
userId	integer(int64)
viewCount	integer(int64)
womanCover	string
womanName	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"bgCover": "",
		"countdownTime": "",
		"countdownTitle": "",
		"createTime": "",
		"familyInfo": "",
		"id": 0,
		"isDelete": 0,
		"likeCount": 0,
		"manCover": "",
		"manName": "",
		"status": 0,
		"timing": "",
		"updateTime": "",
		"userId": 0,
		"viewCount": 0,
		"womanCover": "",
		"womanName": ""
	},
	"message": ""
}

listLoveBoardsByPage

接口地址:/love-board/list/page/admin

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "id": 0,
  "manName": "",
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "status": 0,
  "userId": 0,
  "womanName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
loveBoardAdminRequest	loveBoardAdminRequest	body	true	LoveBoardAdminRequest	LoveBoardAdminRequest
current			false	integer(int32)
id			false	integer(int64)
manName			false	string
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
status			false	integer(int32)
userId			false	integer(int64)
womanName			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«LoveBoard»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«LoveBoard»	Page«LoveBoard»
current	integer(int64)
pages	integer(int64)
records	array	LoveBoard
bgCover	string
countdownTime	string
countdownTitle	string
createTime	string
familyInfo	string
id	integer
isDelete	integer
likeCount	integer
manCover	string
manName	string
status	integer
timing	string
updateTime	string
userId	integer
viewCount	integer
womanCover	string
womanName	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"bgCover": "",
				"countdownTime": "",
				"countdownTitle": "",
				"createTime": "",
				"familyInfo": "",
				"id": 0,
				"isDelete": 0,
				"likeCount": 0,
				"manCover": "",
				"manName": "",
				"status": 0,
				"timing": "",
				"updateTime": "",
				"userId": 0,
				"viewCount": 0,
				"womanCover": "",
				"womanName": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listPublicLoveBoards

接口地址:/love-board/list/public

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
current	current	query	false	integer(int64)
manName	manName	query	false	string
size	size	query	false	integer(int64)
sortField	sortField	query	false	string
sortOrder	sortOrder	query	false	string
womanName	womanName	query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«LoveBoard»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«LoveBoard»	Page«LoveBoard»
current	integer(int64)
pages	integer(int64)
records	array	LoveBoard
bgCover	string
countdownTime	string
countdownTitle	string
createTime	string
familyInfo	string
id	integer
isDelete	integer
likeCount	integer
manCover	string
manName	string
status	integer
timing	string
updateTime	string
userId	integer
viewCount	integer
womanCover	string
womanName	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"bgCover": "",
				"countdownTime": "",
				"countdownTitle": "",
				"createTime": "",
				"familyInfo": "",
				"id": 0,
				"isDelete": 0,
				"likeCount": 0,
				"manCover": "",
				"manName": "",
				"status": 0,
				"timing": "",
				"updateTime": "",
				"userId": 0,
				"viewCount": 0,
				"womanCover": "",
				"womanName": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

getMyLoveBoard

接口地址:/love-board/my

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«LoveBoard»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	LoveBoard	LoveBoard
bgCover	string
countdownTime	string
countdownTitle	string
createTime	string(date-time)
familyInfo	string
id	integer(int64)
isDelete	integer(int32)
likeCount	integer(int64)
manCover	string
manName	string
status	integer(int32)
timing	string
updateTime	string(date-time)
userId	integer(int64)
viewCount	integer(int64)
womanCover	string
womanName	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"bgCover": "",
		"countdownTime": "",
		"countdownTitle": "",
		"createTime": "",
		"familyInfo": "",
		"id": 0,
		"isDelete": 0,
		"likeCount": 0,
		"manCover": "",
		"manName": "",
		"status": 0,
		"timing": "",
		"updateTime": "",
		"userId": 0,
		"viewCount": 0,
		"womanCover": "",
		"womanName": ""
	},
	"message": ""
}

updateLoveBoard

接口地址:/love-board/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "bgCover": "",
  "countdownTime": "",
  "countdownTitle": "",
  "createTime": "",
  "familyInfo": "",
  "id": 0,
  "isDelete": 0,
  "likeCount": 0,
  "manCover": "",
  "manName": "",
  "status": 0,
  "timing": "",
  "updateTime": "",
  "userId": 0,
  "viewCount": 0,
  "womanCover": "",
  "womanName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
loveBoard	loveBoard	body	true	LoveBoard	LoveBoard
bgCover			false	string
countdownTime			false	string
countdownTitle			false	string
createTime			false	string(date-time)
familyInfo			false	string
id			false	integer(int64)
isDelete			false	integer(int32)
likeCount			false	integer(int64)
manCover			false	string
manName			false	string
status			false	integer(int32)
timing			false	string
updateTime			false	string(date-time)
userId			false	integer(int64)
viewCount			false	integer(int64)
womanCover			false	string
womanName			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

updateLoveBoardAdmin

接口地址:/love-board/update/admin

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "bgCover": "",
  "countdownTime": "",
  "countdownTitle": "",
  "createTime": "",
  "familyInfo": "",
  "id": 0,
  "isDelete": 0,
  "likeCount": 0,
  "manCover": "",
  "manName": "",
  "status": 0,
  "timing": "",
  "updateTime": "",
  "userId": 0,
  "viewCount": 0,
  "womanCover": "",
  "womanName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
loveBoard	loveBoard	body	true	LoveBoard	LoveBoard
bgCover			false	string
countdownTime			false	string
countdownTitle			false	string
createTime			false	string(date-time)
familyInfo			false	string
id			false	integer(int64)
isDelete			false	integer(int32)
likeCount			false	integer(int64)
manCover			false	string
manName			false	string
status			false	integer(int32)
timing			false	string
updateTime			false	string(date-time)
userId			false	integer(int64)
viewCount			false	integer(int64)
womanCover			false	string
womanName			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

love-board-music-album-controller

createMusicAlbum

接口地址:/love-board/music-album/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "albumName": "",
  "coverUrl": "",
  "createTime": "",
  "description": "",
  "id": 0,
  "isDelete": 0,
  "isPublic": 0,
  "loveBoardId": 0,
  "password": "",
  "updateTime": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
loveBoardId	loveBoardId	query	true	integer(int64)
musicAlbum	musicAlbum	body	true	LoveBoardMusicAlbum	LoveBoardMusicAlbum
albumName			false	string
coverUrl			false	string
createTime			false	string(date-time)
description			false	string
id			false	integer(int64)
isDelete			false	integer(int32)
isPublic			false	integer(int32)
loveBoardId			false	integer(int64)
password			false	string
updateTime			false	string(date-time)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

deleteAudioFromAlbum

接口地址:/love-board/music-album/audio/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
albumId	albumId	query	true	integer(int64)
audioId	audioId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

fetchAlbumAudios

接口地址:/love-board/music-album/audios

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
albumId	albumId	query	true	integer(int64)
password	password	query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«AudioFileVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	AudioFileVO
album	string
artist	string
coverUrl	string
createTime	string(date-time)
description	string
duration	integer(int32)
fileName	string
fileSize	integer(int64)
fileUrl	string
genre	string
id	integer(int64)
isLiked	integer(int32)
likeCount	integer(int64)
mimeType	string
title	string
updateTime	string(date-time)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"album": "",
			"artist": "",
			"coverUrl": "",
			"createTime": "",
			"description": "",
			"duration": 0,
			"fileName": "",
			"fileSize": 0,
			"fileUrl": "",
			"genre": "",
			"id": 0,
			"isLiked": 0,
			"likeCount": 0,
			"mimeType": "",
			"title": "",
			"updateTime": "",
			"user": {
				"allowFollow": 0,
				"allowPrivateChat": 0,
				"createTime": "",
				"email": "",
				"fansCount": 0,
				"followCount": 0,
				"homepageBg": "",
				"id": 0,
				"showFansList": 0,
				"showFollowList": 0,
				"userAccount": "",
				"userAvatar": "",
				"userName": "",
				"userProfile": "",
				"userRole": ""
			},
			"userId": 0,
			"viewCount": 0
		}
	],
	"message": ""
}

removeMusicAlbum

接口地址:/love-board/music-album/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	true	integer(int64)
loveBoardId	loveBoardId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

fetchMusicAlbumById

接口地址:/love-board/music-album/get

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	true	integer(int64)
password	password	query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«LoveBoardMusicAlbum»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	LoveBoardMusicAlbum	LoveBoardMusicAlbum
albumName	string
coverUrl	string
createTime	string(date-time)
description	string
id	integer(int64)
isDelete	integer(int32)
isPublic	integer(int32)
loveBoardId	integer(int64)
password	string
updateTime	string(date-time)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"albumName": "",
		"coverUrl": "",
		"createTime": "",
		"description": "",
		"id": 0,
		"isDelete": 0,
		"isPublic": 0,
		"loveBoardId": 0,
		"password": "",
		"updateTime": "",
		"userId": 0
	},
	"message": ""
}

fetchMusicAlbums

接口地址:/love-board/music-album/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
current	current	query	true	integer(int64)
loveBoardId	loveBoardId	query	true	integer(int64)
pageSize	pageSize	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«LoveBoardMusicAlbum»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«LoveBoardMusicAlbum»	Page«LoveBoardMusicAlbum»
current	integer(int64)
pages	integer(int64)
records	array	LoveBoardMusicAlbum
albumName	string
coverUrl	string
createTime	string
description	string
id	integer
isDelete	integer
isPublic	integer
loveBoardId	integer
password	string
updateTime	string
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"albumName": "",
				"coverUrl": "",
				"createTime": "",
				"description": "",
				"id": 0,
				"isDelete": 0,
				"isPublic": 0,
				"loveBoardId": 0,
				"password": "",
				"updateTime": "",
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

removeMusicAlbumPassword

接口地址:/love-board/music-album/password/remove

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "albumId": 0,
  "newPassword": "",
  "oldPassword": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
request	request	body	true	MusicAlbumPasswordRequest	MusicAlbumPasswordRequest
albumId			false	integer(int64)
newPassword			false	string
oldPassword			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

setMusicAlbumPassword

接口地址:/love-board/music-album/password/set

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "albumId": 0,
  "newPassword": "",
  "oldPassword": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
request	request	body	true	MusicAlbumPasswordRequest	MusicAlbumPasswordRequest
albumId			false	integer(int64)
newPassword			false	string
oldPassword			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

modifyMusicAlbumPassword

接口地址:/love-board/music-album/password/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "albumId": 0,
  "newPassword": "",
  "oldPassword": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
request	request	body	true	MusicAlbumPasswordRequest	MusicAlbumPasswordRequest
albumId			false	integer(int64)
newPassword			false	string
oldPassword			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

modifyMusicAlbum

接口地址:/love-board/music-album/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "albumName": "",
  "coverUrl": "",
  "createTime": "",
  "description": "",
  "id": 0,
  "isDelete": 0,
  "isPublic": 0,
  "loveBoardId": 0,
  "password": "",
  "updateTime": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
loveBoardId	loveBoardId	query	true	integer(int64)
musicAlbum	musicAlbum	body	true	LoveBoardMusicAlbum	LoveBoardMusicAlbum
albumName			false	string
coverUrl			false	string
createTime			false	string(date-time)
description			false	string
id			false	integer(int64)
isDelete			false	integer(int32)
isPublic			false	integer(int32)
loveBoardId			false	integer(int64)
password			false	string
updateTime			false	string(date-time)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

uploadMusicToAlbum

接口地址:/love-board/music-album/upload

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
albumId	albumId	query	true	integer(int64)
file	file	formData	true	file
album	album	query	false	string
artist	artist	query	false	string
coverUrl	coverUrl	query	false	string
description	description	query	false	string
genre	genre	query	false	string
title	title	query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«AudioFileVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	AudioFileVO	AudioFileVO
album	string
artist	string
coverUrl	string
createTime	string(date-time)
description	string
duration	integer(int32)
fileName	string
fileSize	integer(int64)
fileUrl	string
genre	string
id	integer(int64)
isLiked	integer(int32)
likeCount	integer(int64)
mimeType	string
title	string
updateTime	string(date-time)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"album": "",
		"artist": "",
		"coverUrl": "",
		"createTime": "",
		"description": "",
		"duration": 0,
		"fileName": "",
		"fileSize": 0,
		"fileUrl": "",
		"genre": "",
		"id": 0,
		"isLiked": 0,
		"likeCount": 0,
		"mimeType": "",
		"title": "",
		"updateTime": "",
		"user": {
			"allowFollow": 0,
			"allowPrivateChat": 0,
			"createTime": "",
			"email": "",
			"fansCount": 0,
			"followCount": 0,
			"homepageBg": "",
			"id": 0,
			"showFansList": 0,
			"showFollowList": 0,
			"userAccount": "",
			"userAvatar": "",
			"userName": "",
			"userProfile": "",
			"userRole": ""
		},
		"userId": 0,
		"viewCount": 0
	},
	"message": ""
}

main-controller

health

接口地址:/health

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

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

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	string
message	string

响应示例:

javascript

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

message-board-controller

addMessage

接口地址:/message-board/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "browser": "",
  "content": "",
  "createTime": "",
  "id": 0,
  "ipAddress": "",
  "isDelete": 0,
  "likeCount": 0,
  "location": "",
  "nickname": "",
  "os": "",
  "ownerId": 0,
  "qq": "",
  "status": 0,
  "updateTime": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
messageBoard	messageBoard	body	true	MessageBoard	MessageBoard
browser			false	string
content			false	string
createTime			false	string(date-time)
id			false	integer(int64)
ipAddress			false	string
isDelete			false	integer(int32)
likeCount			false	integer(int32)
location			false	string
nickname			false	string
os			false	string
ownerId			false	integer(int64)
qq			false	string
status			false	integer(int32)
updateTime			false	string(date-time)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

likeMessage

接口地址:/message-board/like/{id}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

listMessagesByPage

接口地址:/message-board/list/page

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
ownerId	ownerId	query	true	integer(int64)
current	current	query	false	integer(int64)
size	size	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«MessageBoard»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«MessageBoard»	Page«MessageBoard»
current	integer(int64)
pages	integer(int64)
records	array	MessageBoard
browser	string
content	string
createTime	string
id	integer
ipAddress	string
isDelete	integer
likeCount	integer
location	string
nickname	string
os	string
ownerId	integer
qq	string
status	integer
updateTime	string
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"browser": "",
				"content": "",
				"createTime": "",
				"id": 0,
				"ipAddress": "",
				"isDelete": 0,
				"likeCount": 0,
				"location": "",
				"nickname": "",
				"os": "",
				"ownerId": 0,
				"qq": "",
				"status": 0,
				"updateTime": "",
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

updateMessageStatus

接口地址:/message-board/status

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	true	integer(int64)
status	status	query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

deleteMessage

接口地址:/message-board/{id}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)
ownerId	ownerId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

message-center-controller

getMessageList

接口地址:/message/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
type	type	query	true	string
current	current	query	false	integer(int64)
pageSize	pageSize	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«object»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«object»	Page«object»
current	integer(int64)
pages	integer(int64)
records	array	object
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [],
		"size": 0,
		"total": 0
	},
	"message": ""
}

markAllAsRead

接口地址:/message/read/all

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

markSingleAsRead

接口地址:/message/read/{type}/{id}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)
type	type	path	true	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getAllUnreadCount

接口地址:/message/unread/count/all

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«MessageCenterVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	MessageCenterVO	MessageCenterVO
totalUnread	integer(int64)
unreadComments	integer(int64)
unreadLikes	integer(int64)
unreadShares	integer(int64)
unreadSystemNotifies	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"totalUnread": 0,
		"unreadComments": 0,
		"unreadLikes": 0,
		"unreadShares": 0,
		"unreadSystemNotifies": 0
	},
	"message": ""
}

message-controller

sendMessage

接口地址:/message/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "content": "",
  "ip": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
addMessage	addMessage	body	true	AddMessage	AddMessage
content			false	string
ip			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

batchAdminOperationMessages

接口地址:/message/batch

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "ids": [],
  "operation": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
messageBatchRequest	messageBatchRequest	body	true	MessageBatchRequest	MessageBatchRequest
ids			false	array	integer(int64)
operation			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

deleteMessage

接口地址:/message/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getAdminMessageById

接口地址:/message/get/admin

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Message»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Message	Message
content	string
createTime	string(date-time)
id	integer(int64)
ip	string
isDelete	integer(int32)
updateTime	string(date-time)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"content": "",
		"createTime": "",
		"id": 0,
		"ip": "",
		"isDelete": 0,
		"updateTime": ""
	},
	"message": ""
}

getTop500

接口地址:/message/getTop500

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«MessageVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	MessageVO
content	string
createTime	string(date-time)
id	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"content": "",
			"createTime": "",
			"id": 0
		}
	],
	"message": ""
}

listMessageByPage

接口地址:/message/list/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "content": "",
  "current": 0,
  "ip": "",
  "pageSize": 0,
  "sortField": "",
  "sortOrder": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
messageQueryRequest	messageQueryRequest	body	true	MessageQueryRequest	MessageQueryRequest
content			false	string
current			false	integer(int32)
ip			false	string
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«Message»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«Message»	Page«Message»
current	integer(int64)
pages	integer(int64)
records	array	Message
content	string
createTime	string
id	integer
ip	string
isDelete	integer
updateTime	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"content": "",
				"createTime": "",
				"id": 0,
				"ip": "",
				"isDelete": 0,
				"updateTime": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listAdminMessagesByPage

接口地址:/message/list/page/admin

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "content": "",
  "current": 0,
  "id": 0,
  "ip": "",
  "pageSize": 0,
  "sortField": "",
  "sortOrder": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
messageAdminRequest	messageAdminRequest	body	true	MessageAdminRequest	MessageAdminRequest
content			false	string
current			false	integer(int64)
id			false	integer(int64)
ip			false	string
pageSize			false	integer(int64)
sortField			false	string
sortOrder			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«Message»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«Message»	Page«Message»
current	integer(int64)
pages	integer(int64)
records	array	Message
content	string
createTime	string
id	integer
ip	string
isDelete	integer
updateTime	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"content": "",
				"createTime": "",
				"id": 0,
				"ip": "",
				"isDelete": 0,
				"updateTime": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

message-qa-controller

getQaAnswer

接口地址:/rag/qa/message/answer

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "content": "",
  "current": 0,
  "isDelete": 0,
  "messageType": 0,
  "pageSize": 0,
  "sessionId": 0,
  "sortField": "",
  "sortOrder": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
messageQueryRequest	messageQueryRequest	body	true	QaMessageQueryRequest	QaMessageQueryRequest
content			false	string
current			false	integer(int32)
isDelete			false	integer(int32)
messageType			false	integer(int32)
pageSize			false	integer(int32)
sessionId			false	integer(int64)
sortField			false	string
sortOrder			false	string
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«RagMessageVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	RagMessageVO	RagMessageVO
content	string
createTime	string(date-time)
id	integer(int64)
isDelete	integer(int32)
messageType	integer(int32)
sessionId	integer(int64)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"content": "",
		"createTime": "",
		"id": 0,
		"isDelete": 0,
		"messageType": 0,
		"sessionId": 0,
		"userId": 0
	},
	"message": ""
}

clearSessionContext

接口地址:/rag/qa/message/clearContext

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
sessionId	sessionId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«RagMessageVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	RagMessageVO	RagMessageVO
content	string
createTime	string(date-time)
id	integer(int64)
isDelete	integer(int32)
messageType	integer(int32)
sessionId	integer(int64)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"content": "",
		"createTime": "",
		"id": 0,
		"isDelete": 0,
		"messageType": 0,
		"sessionId": 0,
		"userId": 0
	},
	"message": ""
}

deleteMessageById

接口地址:/rag/qa/message/delete/admin

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "id": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deleteRequest	deleteRequest	body	true	DeleteRequest	DeleteRequest
id			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

deleteBatchMessages

接口地址:/rag/qa/message/delete/batch

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

[
  {
    "id": 0
  }
]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deleteRequestList	deleteRequestList	body	true	array	DeleteRequest
id			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getMessageById

接口地址:/rag/qa/message/get

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«RagMessageVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	RagMessageVO	RagMessageVO
content	string
createTime	string(date-time)
id	integer(int64)
isDelete	integer(int32)
messageType	integer(int32)
sessionId	integer(int64)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"content": "",
		"createTime": "",
		"id": 0,
		"isDelete": 0,
		"messageType": 0,
		"sessionId": 0,
		"userId": 0
	},
	"message": ""
}

listQaMessages

接口地址:/rag/qa/message/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	请求类型	是否必须	数据类型
content	query	false	string
current	query	false	integer(int32)
isDelete	query	false	integer(int32)
messageType	query	false	integer(int32)
pageSize	query	false	integer(int32)
sessionId	query	false	integer(int64)
sortField	query	false	string
sortOrder	query	false	string
userId	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«IPage«RagMessageVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	IPage«RagMessageVO»	IPage«RagMessageVO»
current	integer(int64)
pages	integer(int64)
records	array	RagMessageVO
content	string
createTime	string
id	integer
isDelete	integer
messageType	integer
sessionId	integer
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"content": "",
				"createTime": "",
				"id": 0,
				"isDelete": 0,
				"messageType": 0,
				"sessionId": 0,
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listAllMessagesByPage

接口地址:/rag/qa/message/list/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "content": "",
  "current": 0,
  "isDelete": 0,
  "messageType": 0,
  "pageSize": 0,
  "sessionId": 0,
  "sortField": "",
  "sortOrder": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
messageQueryRequest	messageQueryRequest	body	false	QaMessageQueryRequest	QaMessageQueryRequest
content			false	string
current			false	integer(int32)
isDelete			false	integer(int32)
messageType			false	integer(int32)
pageSize			false	integer(int32)
sessionId			false	integer(int64)
sortField			false	string
sortOrder			false	string
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«IPage«RagMessageVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	IPage«RagMessageVO»	IPage«RagMessageVO»
current	integer(int64)
pages	integer(int64)
records	array	RagMessageVO
content	string
createTime	string
id	integer
isDelete	integer
messageType	integer
sessionId	integer
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"content": "",
				"createTime": "",
				"id": 0,
				"isDelete": 0,
				"messageType": 0,
				"sessionId": 0,
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listMessagesBySessionId

接口地址:/rag/qa/message/list/session

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
sessionId	sessionId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«RagMessageVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	RagMessageVO
content	string
createTime	string(date-time)
id	integer(int64)
isDelete	integer(int32)
messageType	integer(int32)
sessionId	integer(int64)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"content": "",
			"createTime": "",
			"id": 0,
			"isDelete": 0,
			"messageType": 0,
			"sessionId": 0,
			"userId": 0
		}
	],
	"message": ""
}

sendQaMessage

接口地址:/rag/qa/message/send

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "content": "",
  "sessionId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
messageAddRequest	messageAddRequest	body	true	QaMessageAddRequest	QaMessageAddRequest
content			false	string
sessionId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«RagMessageVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	RagMessageVO	RagMessageVO
content	string
createTime	string(date-time)
id	integer(int64)
isDelete	integer(int32)
messageType	integer(int32)
sessionId	integer(int64)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"content": "",
		"createTime": "",
		"id": 0,
		"isDelete": 0,
		"messageType": 0,
		"sessionId": 0,
		"userId": 0
	},
	"message": ""
}

sendQaStreamMessage

接口地址:/rag/qa/message/send/stream

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:text/event-stream

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
message	message	query	true	string
sessionId	sessionId	query	false	integer(int64)

响应状态:

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

响应参数:

参数名称	参数说明	类型	schema
timeout		integer(int64)	integer(int64)

响应示例:

javascript

{
	"timeout": 0
}

picture-controller

batchOperationPicture

接口地址:/picture/batchOption

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "ids": [],
  "operationType": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pictureOperation	pictureOperation	body	true	PictureOperation	PictureOperation
ids			false	array	integer(int64)
operationType			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

copyPictureToNewSpace

接口地址:/picture/copy

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "pictureId": 0,
  "spaceId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
copyPictureRequest	copyPictureRequest	body	true	CopyPictureRequest	CopyPictureRequest
pictureId			false	integer(int64)
spaceId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«PictureVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	PictureVO	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer(int64)
commentCount	integer(int64)
createTime	string(date-time)
editTime	string(date-time)
favoriteCount	integer(int64)
id	integer(int64)
introduction	string
isDownload	integer(int32)
isFavorited	integer(int32)
isFeature	integer(int32)
isLiked	integer(int32)
isShared	integer(int32)
likeCount	integer(int64)
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer(int32)
picScale	number(double)
picSize	integer(int64)
picWidth	integer(int32)
recommendScore	number(double)
reviewMessage	string
reviewStatus	integer(int32)
shareCount	integer(int64)
spaceId	integer(int64)
tags	array	string
thumbnailUrl	string
updateTime	string(date-time)
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"allowCollect": true,
		"allowComment": true,
		"allowLike": true,
		"allowShare": true,
		"category": "",
		"chatCount": 0,
		"commentCount": 0,
		"createTime": "",
		"editTime": "",
		"favoriteCount": 0,
		"id": 0,
		"introduction": "",
		"isDownload": 0,
		"isFavorited": 0,
		"isFeature": 0,
		"isLiked": 0,
		"isShared": 0,
		"likeCount": 0,
		"name": "",
		"permissionList": [],
		"picColor": "",
		"picFormat": "",
		"picHeight": 0,
		"picScale": 0,
		"picSize": 0,
		"picWidth": 0,
		"recommendScore": 0,
		"reviewMessage": "",
		"reviewStatus": 0,
		"shareCount": 0,
		"spaceId": 0,
		"tags": [],
		"thumbnailUrl": "",
		"updateTime": "",
		"url": "",
		"user": {
			"allowFollow": 0,
			"allowPrivateChat": 0,
			"createTime": "",
			"email": "",
			"fansCount": 0,
			"followCount": 0,
			"homepageBg": "",
			"id": 0,
			"showFansList": 0,
			"showFollowList": 0,
			"userAccount": "",
			"userAvatar": "",
			"userName": "",
			"userProfile": "",
			"userRole": ""
		},
		"userId": 0,
		"viewCount": 0
	},
	"message": ""
}

deletePicture

接口地址:/picture/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "id": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deleteRequest	deleteRequest	body	true	DeleteRequest	DeleteRequest
id			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getLatestDraft

接口地址:/picture/draft/latest

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Picture»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Picture	Picture
allowCollect	integer(int32)
allowComment	integer(int32)
allowLike	integer(int32)
allowShare	integer(int32)
category	string
commentCount	integer(int64)
createTime	string(date-time)
editTime	string(date-time)
favoriteCount	integer(int64)
hotScore	number(double)
id	integer(int64)
introduction	string
isDelete	integer(int32)
isDownload	integer(int32)
isDraft	integer(int32)
isFeature	integer(int32)
likeCount	integer(int64)
name	string
picColor	string
picFormat	string
picHeight	integer(int32)
picScale	number(double)
picSize	integer(int64)
picWidth	integer(int32)
recommendScore	number(double)
reviewMessage	string
reviewStatus	integer(int32)
reviewTime	string(date-time)
reviewerId	integer(int64)
shareCount	integer(int64)
spaceId	integer(int64)
tags	string
thumbnailUrl	string
updateTime	string(date-time)
url	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"allowCollect": 0,
		"allowComment": 0,
		"allowLike": 0,
		"allowShare": 0,
		"category": "",
		"commentCount": 0,
		"createTime": "",
		"editTime": "",
		"favoriteCount": 0,
		"hotScore": 0,
		"id": 0,
		"introduction": "",
		"isDelete": 0,
		"isDownload": 0,
		"isDraft": 0,
		"isFeature": 0,
		"likeCount": 0,
		"name": "",
		"picColor": "",
		"picFormat": "",
		"picHeight": 0,
		"picScale": 0,
		"picSize": 0,
		"picWidth": 0,
		"recommendScore": 0,
		"reviewMessage": "",
		"reviewStatus": 0,
		"reviewTime": "",
		"reviewerId": 0,
		"shareCount": 0,
		"spaceId": 0,
		"tags": "",
		"thumbnailUrl": "",
		"updateTime": "",
		"url": "",
		"userId": 0,
		"viewCount": 0
	},
	"message": ""
}

listDraftPictures

接口地址:/picture/draft/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«Picture»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	Picture
allowCollect	integer(int32)
allowComment	integer(int32)
allowLike	integer(int32)
allowShare	integer(int32)
category	string
commentCount	integer(int64)
createTime	string(date-time)
editTime	string(date-time)
favoriteCount	integer(int64)
hotScore	number(double)
id	integer(int64)
introduction	string
isDelete	integer(int32)
isDownload	integer(int32)
isDraft	integer(int32)
isFeature	integer(int32)
likeCount	integer(int64)
name	string
picColor	string
picFormat	string
picHeight	integer(int32)
picScale	number(double)
picSize	integer(int64)
picWidth	integer(int32)
recommendScore	number(double)
reviewMessage	string
reviewStatus	integer(int32)
reviewTime	string(date-time)
reviewerId	integer(int64)
shareCount	integer(int64)
spaceId	integer(int64)
tags	string
thumbnailUrl	string
updateTime	string(date-time)
url	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"allowCollect": 0,
			"allowComment": 0,
			"allowLike": 0,
			"allowShare": 0,
			"category": "",
			"commentCount": 0,
			"createTime": "",
			"editTime": "",
			"favoriteCount": 0,
			"hotScore": 0,
			"id": 0,
			"introduction": "",
			"isDelete": 0,
			"isDownload": 0,
			"isDraft": 0,
			"isFeature": 0,
			"likeCount": 0,
			"name": "",
			"picColor": "",
			"picFormat": "",
			"picHeight": 0,
			"picScale": 0,
			"picSize": 0,
			"picWidth": 0,
			"recommendScore": 0,
			"reviewMessage": "",
			"reviewStatus": 0,
			"reviewTime": "",
			"reviewerId": 0,
			"shareCount": 0,
			"spaceId": 0,
			"tags": "",
			"thumbnailUrl": "",
			"updateTime": "",
			"url": "",
			"userId": 0,
			"viewCount": 0
		}
	],
	"message": ""
}

updatePictureDraftStatus

接口地址:/picture/draft/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "isDraft": 0,
  "pictureId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
updatePictureDraftRequest	updatePictureDraftRequest	body	true	UpdatePictureDraftRequest	UpdatePictureDraftRequest
isDraft			false	integer(int32)
pictureId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

editPicture

接口地址:/picture/edit

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "category": "",
  "id": 0,
  "introduction": "",
  "isDownload": 0,
  "name": "",
  "tags": []
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pictureEditRequest	pictureEditRequest	body	true	PictureEditRequest	PictureEditRequest
category			false	string
id			false	integer(int64)
introduction			false	string
isDownload			false	integer(int32)
name			false	string
tags			false	array	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

editPictureByBatch

接口地址:/picture/edit/batch

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "category": "",
  "nameRule": "",
  "pictureIdList": [],
  "spaceId": 0,
  "tags": []
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pictureEditByBatchRequest	pictureEditByBatchRequest	body	true	PictureEditByBatchRequest	PictureEditByBatchRequest
category			false	string
nameRule			false	string
pictureIdList			false	array	integer(int64)
spaceId			false	integer(int64)
tags			false	array	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

setPictureFeature

接口地址:/picture/feature

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "id": 0,
  "isFeature": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pictureFeatureRequest	pictureFeatureRequest	body	true	PictureFeatureRequest	PictureFeatureRequest
id			false	integer(int64)
isFeature			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getFeaturePicture

接口地址:/picture/feature/list

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "category": "",
  "current": 0,
  "endEditTime": "",
  "id": 0,
  "introduction": "",
  "name": "",
  "nullSpaceId": true,
  "pageSize": 0,
  "picColor": "",
  "picFormat": "",
  "picHeight": 0,
  "picScale": 0,
  "picSize": 0,
  "picWidth": 0,
  "reviewMessage": "",
  "reviewStatus": 0,
  "reviewTime": "",
  "reviewerId": 0,
  "searchText": "",
  "sortField": "",
  "sortOrder": "",
  "spaceId": 0,
  "startEditTime": "",
  "tags": [],
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pictureQueryRequest	pictureQueryRequest	body	true	PictureQueryRequest	PictureQueryRequest
category			false	string
current			false	integer(int32)
endEditTime			false	string(date-time)
id			false	integer(int64)
introduction			false	string
name			false	string
nullSpaceId			false	boolean
pageSize			false	integer(int32)
picColor			false	string
picFormat			false	string
picHeight			false	integer(int32)
picScale			false	number(double)
picSize			false	integer(int64)
picWidth			false	integer(int32)
reviewMessage			false	string
reviewStatus			false	integer(int32)
reviewTime			false	string(date-time)
reviewerId			false	integer(int64)
searchText			false	string
sortField			false	string
sortOrder			false	string
spaceId			false	integer(int64)
startEditTime			false	string(date-time)
tags			false	array	string
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«PictureVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«PictureVO»	Page«PictureVO»
current	integer(int64)
pages	integer(int64)
records	array	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer
commentCount	integer
createTime	string
editTime	string
favoriteCount	integer
id	integer
introduction	string
isDownload	integer
isFavorited	integer
isFeature	integer
isLiked	integer
isShared	integer
likeCount	integer
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer
picScale	number
picSize	integer
picWidth	integer
recommendScore	number
reviewMessage	string
reviewStatus	integer
shareCount	integer
spaceId	integer
tags	array	string
thumbnailUrl	string
updateTime	string
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"allowCollect": true,
				"allowComment": true,
				"allowLike": true,
				"allowShare": true,
				"category": "",
				"chatCount": 0,
				"commentCount": 0,
				"createTime": "",
				"editTime": "",
				"favoriteCount": 0,
				"id": 0,
				"introduction": "",
				"isDownload": 0,
				"isFavorited": 0,
				"isFeature": 0,
				"isLiked": 0,
				"isShared": 0,
				"likeCount": 0,
				"name": "",
				"permissionList": [],
				"picColor": "",
				"picFormat": "",
				"picHeight": 0,
				"picScale": 0,
				"picSize": 0,
				"picWidth": 0,
				"recommendScore": 0,
				"reviewMessage": "",
				"reviewStatus": 0,
				"shareCount": 0,
				"spaceId": 0,
				"tags": [],
				"thumbnailUrl": "",
				"updateTime": "",
				"url": "",
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				},
				"userId": 0,
				"viewCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

getFollowPicture

接口地址:/picture/follow

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "category": "",
  "current": 0,
  "endEditTime": "",
  "id": 0,
  "introduction": "",
  "name": "",
  "nullSpaceId": true,
  "pageSize": 0,
  "picColor": "",
  "picFormat": "",
  "picHeight": 0,
  "picScale": 0,
  "picSize": 0,
  "picWidth": 0,
  "reviewMessage": "",
  "reviewStatus": 0,
  "reviewTime": "",
  "reviewerId": 0,
  "searchText": "",
  "sortField": "",
  "sortOrder": "",
  "spaceId": 0,
  "startEditTime": "",
  "tags": [],
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pictureQueryRequest	pictureQueryRequest	body	true	PictureQueryRequest	PictureQueryRequest
category			false	string
current			false	integer(int32)
endEditTime			false	string(date-time)
id			false	integer(int64)
introduction			false	string
name			false	string
nullSpaceId			false	boolean
pageSize			false	integer(int32)
picColor			false	string
picFormat			false	string
picHeight			false	integer(int32)
picScale			false	number(double)
picSize			false	integer(int64)
picWidth			false	integer(int32)
reviewMessage			false	string
reviewStatus			false	integer(int32)
reviewTime			false	string(date-time)
reviewerId			false	integer(int64)
searchText			false	string
sortField			false	string
sortOrder			false	string
spaceId			false	integer(int64)
startEditTime			false	string(date-time)
tags			false	array	string
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«PictureVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«PictureVO»	Page«PictureVO»
current	integer(int64)
pages	integer(int64)
records	array	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer
commentCount	integer
createTime	string
editTime	string
favoriteCount	integer
id	integer
introduction	string
isDownload	integer
isFavorited	integer
isFeature	integer
isLiked	integer
isShared	integer
likeCount	integer
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer
picScale	number
picSize	integer
picWidth	integer
recommendScore	number
reviewMessage	string
reviewStatus	integer
shareCount	integer
spaceId	integer
tags	array	string
thumbnailUrl	string
updateTime	string
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"allowCollect": true,
				"allowComment": true,
				"allowLike": true,
				"allowShare": true,
				"category": "",
				"chatCount": 0,
				"commentCount": 0,
				"createTime": "",
				"editTime": "",
				"favoriteCount": 0,
				"id": 0,
				"introduction": "",
				"isDownload": 0,
				"isFavorited": 0,
				"isFeature": 0,
				"isLiked": 0,
				"isShared": 0,
				"likeCount": 0,
				"name": "",
				"permissionList": [],
				"picColor": "",
				"picFormat": "",
				"picHeight": 0,
				"picScale": 0,
				"picSize": 0,
				"picWidth": 0,
				"recommendScore": 0,
				"reviewMessage": "",
				"reviewStatus": 0,
				"shareCount": 0,
				"spaceId": 0,
				"tags": [],
				"thumbnailUrl": "",
				"updateTime": "",
				"url": "",
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				},
				"userId": 0,
				"viewCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

getPictureById

接口地址:/picture/get

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Picture»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Picture	Picture
allowCollect	integer(int32)
allowComment	integer(int32)
allowLike	integer(int32)
allowShare	integer(int32)
category	string
commentCount	integer(int64)
createTime	string(date-time)
editTime	string(date-time)
favoriteCount	integer(int64)
hotScore	number(double)
id	integer(int64)
introduction	string
isDelete	integer(int32)
isDownload	integer(int32)
isDraft	integer(int32)
isFeature	integer(int32)
likeCount	integer(int64)
name	string
picColor	string
picFormat	string
picHeight	integer(int32)
picScale	number(double)
picSize	integer(int64)
picWidth	integer(int32)
recommendScore	number(double)
reviewMessage	string
reviewStatus	integer(int32)
reviewTime	string(date-time)
reviewerId	integer(int64)
shareCount	integer(int64)
spaceId	integer(int64)
tags	string
thumbnailUrl	string
updateTime	string(date-time)
url	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"allowCollect": 0,
		"allowComment": 0,
		"allowLike": 0,
		"allowShare": 0,
		"category": "",
		"commentCount": 0,
		"createTime": "",
		"editTime": "",
		"favoriteCount": 0,
		"hotScore": 0,
		"id": 0,
		"introduction": "",
		"isDelete": 0,
		"isDownload": 0,
		"isDraft": 0,
		"isFeature": 0,
		"likeCount": 0,
		"name": "",
		"picColor": "",
		"picFormat": "",
		"picHeight": 0,
		"picScale": 0,
		"picSize": 0,
		"picWidth": 0,
		"recommendScore": 0,
		"reviewMessage": "",
		"reviewStatus": 0,
		"reviewTime": "",
		"reviewerId": 0,
		"shareCount": 0,
		"spaceId": 0,
		"tags": "",
		"thumbnailUrl": "",
		"updateTime": "",
		"url": "",
		"userId": 0,
		"viewCount": 0
	},
	"message": ""
}

getPictureVOById

接口地址:/picture/get/vo

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«PictureVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	PictureVO	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer(int64)
commentCount	integer(int64)
createTime	string(date-time)
editTime	string(date-time)
favoriteCount	integer(int64)
id	integer(int64)
introduction	string
isDownload	integer(int32)
isFavorited	integer(int32)
isFeature	integer(int32)
isLiked	integer(int32)
isShared	integer(int32)
likeCount	integer(int64)
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer(int32)
picScale	number(double)
picSize	integer(int64)
picWidth	integer(int32)
recommendScore	number(double)
reviewMessage	string
reviewStatus	integer(int32)
shareCount	integer(int64)
spaceId	integer(int64)
tags	array	string
thumbnailUrl	string
updateTime	string(date-time)
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"allowCollect": true,
		"allowComment": true,
		"allowLike": true,
		"allowShare": true,
		"category": "",
		"chatCount": 0,
		"commentCount": 0,
		"createTime": "",
		"editTime": "",
		"favoriteCount": 0,
		"id": 0,
		"introduction": "",
		"isDownload": 0,
		"isFavorited": 0,
		"isFeature": 0,
		"isLiked": 0,
		"isShared": 0,
		"likeCount": 0,
		"name": "",
		"permissionList": [],
		"picColor": "",
		"picFormat": "",
		"picHeight": 0,
		"picScale": 0,
		"picSize": 0,
		"picWidth": 0,
		"recommendScore": 0,
		"reviewMessage": "",
		"reviewStatus": 0,
		"shareCount": 0,
		"spaceId": 0,
		"tags": [],
		"thumbnailUrl": "",
		"updateTime": "",
		"url": "",
		"user": {
			"allowFollow": 0,
			"allowPrivateChat": 0,
			"createTime": "",
			"email": "",
			"fansCount": 0,
			"followCount": 0,
			"homepageBg": "",
			"id": 0,
			"showFansList": 0,
			"showFollowList": 0,
			"userAccount": "",
			"userAvatar": "",
			"userName": "",
			"userProfile": "",
			"userRole": ""
		},
		"userId": 0,
		"viewCount": 0
	},
	"message": ""
}

listPictureByPage

接口地址:/picture/list/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "category": "",
  "current": 0,
  "endEditTime": "",
  "id": 0,
  "introduction": "",
  "name": "",
  "nullSpaceId": true,
  "pageSize": 0,
  "picColor": "",
  "picFormat": "",
  "picHeight": 0,
  "picScale": 0,
  "picSize": 0,
  "picWidth": 0,
  "reviewMessage": "",
  "reviewStatus": 0,
  "reviewTime": "",
  "reviewerId": 0,
  "searchText": "",
  "sortField": "",
  "sortOrder": "",
  "spaceId": 0,
  "startEditTime": "",
  "tags": [],
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pictureQueryRequest	pictureQueryRequest	body	true	PictureQueryRequest	PictureQueryRequest
category			false	string
current			false	integer(int32)
endEditTime			false	string(date-time)
id			false	integer(int64)
introduction			false	string
name			false	string
nullSpaceId			false	boolean
pageSize			false	integer(int32)
picColor			false	string
picFormat			false	string
picHeight			false	integer(int32)
picScale			false	number(double)
picSize			false	integer(int64)
picWidth			false	integer(int32)
reviewMessage			false	string
reviewStatus			false	integer(int32)
reviewTime			false	string(date-time)
reviewerId			false	integer(int64)
searchText			false	string
sortField			false	string
sortOrder			false	string
spaceId			false	integer(int64)
startEditTime			false	string(date-time)
tags			false	array	string
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«Picture»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«Picture»	Page«Picture»
current	integer(int64)
pages	integer(int64)
records	array	Picture
allowCollect	integer
allowComment	integer
allowLike	integer
allowShare	integer
category	string
commentCount	integer
createTime	string
editTime	string
favoriteCount	integer
hotScore	number
id	integer
introduction	string
isDelete	integer
isDownload	integer
isDraft	integer
isFeature	integer
likeCount	integer
name	string
picColor	string
picFormat	string
picHeight	integer
picScale	number
picSize	integer
picWidth	integer
recommendScore	number
reviewMessage	string
reviewStatus	integer
reviewTime	string
reviewerId	integer
shareCount	integer
spaceId	integer
tags	string
thumbnailUrl	string
updateTime	string
url	string
userId	integer
viewCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"allowCollect": 0,
				"allowComment": 0,
				"allowLike": 0,
				"allowShare": 0,
				"category": "",
				"commentCount": 0,
				"createTime": "",
				"editTime": "",
				"favoriteCount": 0,
				"hotScore": 0,
				"id": 0,
				"introduction": "",
				"isDelete": 0,
				"isDownload": 0,
				"isDraft": 0,
				"isFeature": 0,
				"likeCount": 0,
				"name": "",
				"picColor": "",
				"picFormat": "",
				"picHeight": 0,
				"picScale": 0,
				"picSize": 0,
				"picWidth": 0,
				"recommendScore": 0,
				"reviewMessage": "",
				"reviewStatus": 0,
				"reviewTime": "",
				"reviewerId": 0,
				"shareCount": 0,
				"spaceId": 0,
				"tags": "",
				"thumbnailUrl": "",
				"updateTime": "",
				"url": "",
				"userId": 0,
				"viewCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listPictureVOByPage

接口地址:/picture/list/page/vo

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "category": "",
  "current": 0,
  "endEditTime": "",
  "id": 0,
  "introduction": "",
  "name": "",
  "nullSpaceId": true,
  "pageSize": 0,
  "picColor": "",
  "picFormat": "",
  "picHeight": 0,
  "picScale": 0,
  "picSize": 0,
  "picWidth": 0,
  "reviewMessage": "",
  "reviewStatus": 0,
  "reviewTime": "",
  "reviewerId": 0,
  "searchText": "",
  "sortField": "",
  "sortOrder": "",
  "spaceId": 0,
  "startEditTime": "",
  "tags": [],
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pictureQueryRequest	pictureQueryRequest	body	true	PictureQueryRequest	PictureQueryRequest
category			false	string
current			false	integer(int32)
endEditTime			false	string(date-time)
id			false	integer(int64)
introduction			false	string
name			false	string
nullSpaceId			false	boolean
pageSize			false	integer(int32)
picColor			false	string
picFormat			false	string
picHeight			false	integer(int32)
picScale			false	number(double)
picSize			false	integer(int64)
picWidth			false	integer(int32)
reviewMessage			false	string
reviewStatus			false	integer(int32)
reviewTime			false	string(date-time)
reviewerId			false	integer(int64)
searchText			false	string
sortField			false	string
sortOrder			false	string
spaceId			false	integer(int64)
startEditTime			false	string(date-time)
tags			false	array	string
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«PictureVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«PictureVO»	Page«PictureVO»
current	integer(int64)
pages	integer(int64)
records	array	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer
commentCount	integer
createTime	string
editTime	string
favoriteCount	integer
id	integer
introduction	string
isDownload	integer
isFavorited	integer
isFeature	integer
isLiked	integer
isShared	integer
likeCount	integer
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer
picScale	number
picSize	integer
picWidth	integer
recommendScore	number
reviewMessage	string
reviewStatus	integer
shareCount	integer
spaceId	integer
tags	array	string
thumbnailUrl	string
updateTime	string
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"allowCollect": true,
				"allowComment": true,
				"allowLike": true,
				"allowShare": true,
				"category": "",
				"chatCount": 0,
				"commentCount": 0,
				"createTime": "",
				"editTime": "",
				"favoriteCount": 0,
				"id": 0,
				"introduction": "",
				"isDownload": 0,
				"isFavorited": 0,
				"isFeature": 0,
				"isLiked": 0,
				"isShared": 0,
				"likeCount": 0,
				"name": "",
				"permissionList": [],
				"picColor": "",
				"picFormat": "",
				"picHeight": 0,
				"picScale": 0,
				"picSize": 0,
				"picWidth": 0,
				"recommendScore": 0,
				"reviewMessage": "",
				"reviewStatus": 0,
				"shareCount": 0,
				"spaceId": 0,
				"tags": [],
				"thumbnailUrl": "",
				"updateTime": "",
				"url": "",
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				},
				"userId": 0,
				"viewCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listPictureVOByPageWithCache

接口地址:/picture/list/page/vo/cache

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "category": "",
  "current": 0,
  "endEditTime": "",
  "id": 0,
  "introduction": "",
  "name": "",
  "nullSpaceId": true,
  "pageSize": 0,
  "picColor": "",
  "picFormat": "",
  "picHeight": 0,
  "picScale": 0,
  "picSize": 0,
  "picWidth": 0,
  "reviewMessage": "",
  "reviewStatus": 0,
  "reviewTime": "",
  "reviewerId": 0,
  "searchText": "",
  "sortField": "",
  "sortOrder": "",
  "spaceId": 0,
  "startEditTime": "",
  "tags": [],
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pictureQueryRequest	pictureQueryRequest	body	true	PictureQueryRequest	PictureQueryRequest
category			false	string
current			false	integer(int32)
endEditTime			false	string(date-time)
id			false	integer(int64)
introduction			false	string
name			false	string
nullSpaceId			false	boolean
pageSize			false	integer(int32)
picColor			false	string
picFormat			false	string
picHeight			false	integer(int32)
picScale			false	number(double)
picSize			false	integer(int64)
picWidth			false	integer(int32)
reviewMessage			false	string
reviewStatus			false	integer(int32)
reviewTime			false	string(date-time)
reviewerId			false	integer(int64)
searchText			false	string
sortField			false	string
sortOrder			false	string
spaceId			false	integer(int64)
startEditTime			false	string(date-time)
tags			false	array	string
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«PictureVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«PictureVO»	Page«PictureVO»
current	integer(int64)
pages	integer(int64)
records	array	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer
commentCount	integer
createTime	string
editTime	string
favoriteCount	integer
id	integer
introduction	string
isDownload	integer
isFavorited	integer
isFeature	integer
isLiked	integer
isShared	integer
likeCount	integer
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer
picScale	number
picSize	integer
picWidth	integer
recommendScore	number
reviewMessage	string
reviewStatus	integer
shareCount	integer
spaceId	integer
tags	array	string
thumbnailUrl	string
updateTime	string
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"allowCollect": true,
				"allowComment": true,
				"allowLike": true,
				"allowShare": true,
				"category": "",
				"chatCount": 0,
				"commentCount": 0,
				"createTime": "",
				"editTime": "",
				"favoriteCount": 0,
				"id": 0,
				"introduction": "",
				"isDownload": 0,
				"isFavorited": 0,
				"isFeature": 0,
				"isLiked": 0,
				"isShared": 0,
				"likeCount": 0,
				"name": "",
				"permissionList": [],
				"picColor": "",
				"picFormat": "",
				"picHeight": 0,
				"picScale": 0,
				"picSize": 0,
				"picWidth": 0,
				"recommendScore": 0,
				"reviewMessage": "",
				"reviewStatus": 0,
				"shareCount": 0,
				"spaceId": 0,
				"tags": [],
				"thumbnailUrl": "",
				"updateTime": "",
				"url": "",
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				},
				"userId": 0,
				"viewCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

createPictureOutPaintingTask

接口地址:/picture/out_painting/create_task

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "parameters": {
    "addWatermark": true,
    "angle": 0,
    "bestQuality": true,
    "bottomOffset": 0,
    "leftOffset": 0,
    "limitImageSize": true,
    "outputRatio": "",
    "rightOffset": 0,
    "topOffset": 0,
    "xScale": 0,
    "yScale": 0
  },
  "pictureId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
createPictureOutPaintingTaskRequest	createPictureOutPaintingTaskRequest	body	true	CreatePictureOutPaintingTaskRequest	CreatePictureOutPaintingTaskRequest
parameters			false	Parameters	Parameters
addWatermark			false	boolean
angle			false	integer
bestQuality			false	boolean
bottomOffset			false	integer
leftOffset			false	integer
limitImageSize			false	boolean
outputRatio			false	string
rightOffset			false	integer
topOffset			false	integer
xScale			false	number
yScale			false	number
pictureId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«CreateOutPaintingTaskResponse»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	CreateOutPaintingTaskResponse	CreateOutPaintingTaskResponse
code	string
message	string
output	Output	Output
taskId	string
taskStatus	string
requestId	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"code": "",
		"message": "",
		"output": {
			"taskId": "",
			"taskStatus": ""
		},
		"requestId": ""
	},
	"message": ""
}

getPictureOutPaintingTask

接口地址:/picture/out_painting/get_task

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
taskId	taskId	query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«GetOutPaintingTaskResponse»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	GetOutPaintingTaskResponse	GetOutPaintingTaskResponse
output	Output_1	Output_1
code	string
endTime	string
message	string
outputImageUrl	string
scheduledTime	string
submitTime	string
taskId	string
taskMetrics	TaskMetrics	TaskMetrics
failed	integer
succeeded	integer
total	integer
taskStatus	string
requestId	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"output": {
			"code": "",
			"endTime": "",
			"message": "",
			"outputImageUrl": "",
			"scheduledTime": "",
			"submitTime": "",
			"taskId": "",
			"taskMetrics": {
				"failed": 0,
				"succeeded": 0,
				"total": 0
			},
			"taskStatus": ""
		},
		"requestId": ""
	},
	"message": ""
}

getPicturePermission

接口地址:/picture/permission/get

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pictureId	pictureId	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Picture»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Picture	Picture
allowCollect	integer(int32)
allowComment	integer(int32)
allowLike	integer(int32)
allowShare	integer(int32)
category	string
commentCount	integer(int64)
createTime	string(date-time)
editTime	string(date-time)
favoriteCount	integer(int64)
hotScore	number(double)
id	integer(int64)
introduction	string
isDelete	integer(int32)
isDownload	integer(int32)
isDraft	integer(int32)
isFeature	integer(int32)
likeCount	integer(int64)
name	string
picColor	string
picFormat	string
picHeight	integer(int32)
picScale	number(double)
picSize	integer(int64)
picWidth	integer(int32)
recommendScore	number(double)
reviewMessage	string
reviewStatus	integer(int32)
reviewTime	string(date-time)
reviewerId	integer(int64)
shareCount	integer(int64)
spaceId	integer(int64)
tags	string
thumbnailUrl	string
updateTime	string(date-time)
url	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"allowCollect": 0,
		"allowComment": 0,
		"allowLike": 0,
		"allowShare": 0,
		"category": "",
		"commentCount": 0,
		"createTime": "",
		"editTime": "",
		"favoriteCount": 0,
		"hotScore": 0,
		"id": 0,
		"introduction": "",
		"isDelete": 0,
		"isDownload": 0,
		"isDraft": 0,
		"isFeature": 0,
		"likeCount": 0,
		"name": "",
		"picColor": "",
		"picFormat": "",
		"picHeight": 0,
		"picScale": 0,
		"picSize": 0,
		"picWidth": 0,
		"recommendScore": 0,
		"reviewMessage": "",
		"reviewStatus": 0,
		"reviewTime": "",
		"reviewerId": 0,
		"shareCount": 0,
		"spaceId": 0,
		"tags": "",
		"thumbnailUrl": "",
		"updateTime": "",
		"url": "",
		"userId": 0,
		"viewCount": 0
	},
	"message": ""
}

setPicturePermission

接口地址:/picture/permission/set

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "allowCollect": 0,
  "allowComment": 0,
  "allowLike": 0,
  "allowShare": 0,
  "pictureId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
permissionRequest	permissionRequest	body	true	PicturePermissionRequest	PicturePermissionRequest
allowCollect			false	integer(int32)
allowComment			false	integer(int32)
allowLike			false	integer(int32)
allowShare			false	integer(int32)
pictureId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

doPictureReview

接口地址:/picture/review

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "id": 0,
  "reviewMessage": "",
  "reviewStatus": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pictureReviewRequest	pictureReviewRequest	body	true	PictureReviewRequest	PictureReviewRequest
id			false	integer(int64)
reviewMessage			false	string
reviewStatus			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

searchPictureByColor

接口地址:/picture/search/color

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "picColor": "",
  "spaceId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
searchPictureByColorRequest	searchPictureByColorRequest	body	true	SearchPictureByColorRequest	SearchPictureByColorRequest
picColor			false	string
spaceId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«PictureVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer(int64)
commentCount	integer(int64)
createTime	string(date-time)
editTime	string(date-time)
favoriteCount	integer(int64)
id	integer(int64)
introduction	string
isDownload	integer(int32)
isFavorited	integer(int32)
isFeature	integer(int32)
isLiked	integer(int32)
isShared	integer(int32)
likeCount	integer(int64)
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer(int32)
picScale	number(double)
picSize	integer(int64)
picWidth	integer(int32)
recommendScore	number(double)
reviewMessage	string
reviewStatus	integer(int32)
shareCount	integer(int64)
spaceId	integer(int64)
tags	array	string
thumbnailUrl	string
updateTime	string(date-time)
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"allowCollect": true,
			"allowComment": true,
			"allowLike": true,
			"allowShare": true,
			"category": "",
			"chatCount": 0,
			"commentCount": 0,
			"createTime": "",
			"editTime": "",
			"favoriteCount": 0,
			"id": 0,
			"introduction": "",
			"isDownload": 0,
			"isFavorited": 0,
			"isFeature": 0,
			"isLiked": 0,
			"isShared": 0,
			"likeCount": 0,
			"name": "",
			"permissionList": [],
			"picColor": "",
			"picFormat": "",
			"picHeight": 0,
			"picScale": 0,
			"picSize": 0,
			"picWidth": 0,
			"recommendScore": 0,
			"reviewMessage": "",
			"reviewStatus": 0,
			"shareCount": 0,
			"spaceId": 0,
			"tags": [],
			"thumbnailUrl": "",
			"updateTime": "",
			"url": "",
			"user": {
				"allowFollow": 0,
				"allowPrivateChat": 0,
				"createTime": "",
				"email": "",
				"fansCount": 0,
				"followCount": 0,
				"homepageBg": "",
				"id": 0,
				"showFansList": 0,
				"showFollowList": 0,
				"userAccount": "",
				"userAvatar": "",
				"userName": "",
				"userProfile": "",
				"userRole": ""
			},
			"userId": 0,
			"viewCount": 0
		}
	],
	"message": ""
}

searchPictureByPicture

接口地址:/picture/search/picture

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "pictureId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
searchPictureByPictureRequest	searchPictureByPictureRequest	body	true	SearchPictureByPictureRequest	SearchPictureByPictureRequest
pictureId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«ImageSearchResult»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	ImageSearchResult
fromUrl	string
thumbUrl	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"fromUrl": "",
			"thumbUrl": ""
		}
	],
	"message": ""
}

listPictureTagCategory

接口地址:/picture/tag_category

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«PictureTagCategory»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	PictureTagCategory	PictureTagCategory
categoryList	array	string
tagList	array	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"categoryList": [],
		"tagList": []
	},
	"message": ""
}

getTop100Picture

接口地址:/picture/top100/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«PictureVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer(int64)
commentCount	integer(int64)
createTime	string(date-time)
editTime	string(date-time)
favoriteCount	integer(int64)
id	integer(int64)
introduction	string
isDownload	integer(int32)
isFavorited	integer(int32)
isFeature	integer(int32)
isLiked	integer(int32)
isShared	integer(int32)
likeCount	integer(int64)
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer(int32)
picScale	number(double)
picSize	integer(int64)
picWidth	integer(int32)
recommendScore	number(double)
reviewMessage	string
reviewStatus	integer(int32)
shareCount	integer(int64)
spaceId	integer(int64)
tags	array	string
thumbnailUrl	string
updateTime	string(date-time)
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"allowCollect": true,
			"allowComment": true,
			"allowLike": true,
			"allowShare": true,
			"category": "",
			"chatCount": 0,
			"commentCount": 0,
			"createTime": "",
			"editTime": "",
			"favoriteCount": 0,
			"id": 0,
			"introduction": "",
			"isDownload": 0,
			"isFavorited": 0,
			"isFeature": 0,
			"isLiked": 0,
			"isShared": 0,
			"likeCount": 0,
			"name": "",
			"permissionList": [],
			"picColor": "",
			"picFormat": "",
			"picHeight": 0,
			"picScale": 0,
			"picSize": 0,
			"picWidth": 0,
			"recommendScore": 0,
			"reviewMessage": "",
			"reviewStatus": 0,
			"shareCount": 0,
			"spaceId": 0,
			"tags": [],
			"thumbnailUrl": "",
			"updateTime": "",
			"url": "",
			"user": {
				"allowFollow": 0,
				"allowPrivateChat": 0,
				"createTime": "",
				"email": "",
				"fansCount": 0,
				"followCount": 0,
				"homepageBg": "",
				"id": 0,
				"showFansList": 0,
				"showFollowList": 0,
				"userAccount": "",
				"userAvatar": "",
				"userName": "",
				"userProfile": "",
				"userRole": ""
			},
			"userId": 0,
			"viewCount": 0
		}
	],
	"message": ""
}

updatePicture

接口地址:/picture/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "allowCollect": 0,
  "allowComment": 0,
  "allowLike": 0,
  "allowShare": 0,
  "category": "",
  "commentCount": 0,
  "createTime": "",
  "editTime": "",
  "favoriteCount": 0,
  "hotScore": 0,
  "id": 0,
  "introduction": "",
  "isDelete": 0,
  "isDownload": 0,
  "isDraft": 0,
  "isFeature": 0,
  "likeCount": 0,
  "name": "",
  "picColor": "",
  "picFormat": "",
  "picHeight": 0,
  "picScale": 0,
  "picSize": 0,
  "picWidth": 0,
  "recommendScore": 0,
  "reviewMessage": "",
  "reviewStatus": 0,
  "reviewTime": "",
  "reviewerId": 0,
  "shareCount": 0,
  "spaceId": 0,
  "tags": "",
  "thumbnailUrl": "",
  "updateTime": "",
  "url": "",
  "userId": 0,
  "viewCount": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
picture	picture	body	true	Picture	Picture
allowCollect			false	integer(int32)
allowComment			false	integer(int32)
allowLike			false	integer(int32)
allowShare			false	integer(int32)
category			false	string
commentCount			false	integer(int64)
createTime			false	string(date-time)
editTime			false	string(date-time)
favoriteCount			false	integer(int64)
hotScore			false	number(double)
id			false	integer(int64)
introduction			false	string
isDelete			false	integer(int32)
isDownload			false	integer(int32)
isDraft			false	integer(int32)
isFeature			false	integer(int32)
likeCount			false	integer(int64)
name			false	string
picColor			false	string
picFormat			false	string
picHeight			false	integer(int32)
picScale			false	number(double)
picSize			false	integer(int64)
picWidth			false	integer(int32)
recommendScore			false	number(double)
reviewMessage			false	string
reviewStatus			false	integer(int32)
reviewTime			false	string(date-time)
reviewerId			false	integer(int64)
shareCount			false	integer(int64)
spaceId			false	integer(int64)
tags			false	string
thumbnailUrl			false	string
updateTime			false	string(date-time)
url			false	string
userId			false	integer(int64)
viewCount			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

uploadPicture

接口地址:/picture/upload

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
file	file	formData	true	file
categoryName		query	false	string
fileUrl		query	false	string
id		query	false	integer(int64)
introduction		query	false	string
picName		query	false	string
spaceId		query	false	integer(int64)
tagName		query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«PictureVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	PictureVO	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer(int64)
commentCount	integer(int64)
createTime	string(date-time)
editTime	string(date-time)
favoriteCount	integer(int64)
id	integer(int64)
introduction	string
isDownload	integer(int32)
isFavorited	integer(int32)
isFeature	integer(int32)
isLiked	integer(int32)
isShared	integer(int32)
likeCount	integer(int64)
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer(int32)
picScale	number(double)
picSize	integer(int64)
picWidth	integer(int32)
recommendScore	number(double)
reviewMessage	string
reviewStatus	integer(int32)
shareCount	integer(int64)
spaceId	integer(int64)
tags	array	string
thumbnailUrl	string
updateTime	string(date-time)
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"allowCollect": true,
		"allowComment": true,
		"allowLike": true,
		"allowShare": true,
		"category": "",
		"chatCount": 0,
		"commentCount": 0,
		"createTime": "",
		"editTime": "",
		"favoriteCount": 0,
		"id": 0,
		"introduction": "",
		"isDownload": 0,
		"isFavorited": 0,
		"isFeature": 0,
		"isLiked": 0,
		"isShared": 0,
		"likeCount": 0,
		"name": "",
		"permissionList": [],
		"picColor": "",
		"picFormat": "",
		"picHeight": 0,
		"picScale": 0,
		"picSize": 0,
		"picWidth": 0,
		"recommendScore": 0,
		"reviewMessage": "",
		"reviewStatus": 0,
		"shareCount": 0,
		"spaceId": 0,
		"tags": [],
		"thumbnailUrl": "",
		"updateTime": "",
		"url": "",
		"user": {
			"allowFollow": 0,
			"allowPrivateChat": 0,
			"createTime": "",
			"email": "",
			"fansCount": 0,
			"followCount": 0,
			"homepageBg": "",
			"id": 0,
			"showFansList": 0,
			"showFollowList": 0,
			"userAccount": "",
			"userAvatar": "",
			"userName": "",
			"userProfile": "",
			"userRole": ""
		},
		"userId": 0,
		"viewCount": 0
	},
	"message": ""
}

uploadPictureByBatch

接口地址:/picture/upload/batch

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "categoryName": "",
  "count": 0,
  "namePrefix": "",
  "searchText": "",
  "tagName": []
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pictureUploadByBatchRequest	pictureUploadByBatchRequest	body	true	PictureUploadByBatchRequest	PictureUploadByBatchRequest
categoryName			false	string
count			false	integer(int32)
namePrefix			false	string
searchText			false	string
tagName			false	array	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«int»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int32)	integer(int32)
message	string

响应示例:

javascript

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

uploadPostImage

接口地址:/picture/upload/postimage

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
file	file	formData	true	file
categoryName		query	false	string
fileUrl		query	false	string
id		query	false	integer(int64)
introduction		query	false	string
picName		query	false	string
spaceId		query	false	integer(int64)
tagName		query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«PictureVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	PictureVO	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer(int64)
commentCount	integer(int64)
createTime	string(date-time)
editTime	string(date-time)
favoriteCount	integer(int64)
id	integer(int64)
introduction	string
isDownload	integer(int32)
isFavorited	integer(int32)
isFeature	integer(int32)
isLiked	integer(int32)
isShared	integer(int32)
likeCount	integer(int64)
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer(int32)
picScale	number(double)
picSize	integer(int64)
picWidth	integer(int32)
recommendScore	number(double)
reviewMessage	string
reviewStatus	integer(int32)
shareCount	integer(int64)
spaceId	integer(int64)
tags	array	string
thumbnailUrl	string
updateTime	string(date-time)
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"allowCollect": true,
		"allowComment": true,
		"allowLike": true,
		"allowShare": true,
		"category": "",
		"chatCount": 0,
		"commentCount": 0,
		"createTime": "",
		"editTime": "",
		"favoriteCount": 0,
		"id": 0,
		"introduction": "",
		"isDownload": 0,
		"isFavorited": 0,
		"isFeature": 0,
		"isLiked": 0,
		"isShared": 0,
		"likeCount": 0,
		"name": "",
		"permissionList": [],
		"picColor": "",
		"picFormat": "",
		"picHeight": 0,
		"picScale": 0,
		"picSize": 0,
		"picWidth": 0,
		"recommendScore": 0,
		"reviewMessage": "",
		"reviewStatus": 0,
		"shareCount": 0,
		"spaceId": 0,
		"tags": [],
		"thumbnailUrl": "",
		"updateTime": "",
		"url": "",
		"user": {
			"allowFollow": 0,
			"allowPrivateChat": 0,
			"createTime": "",
			"email": "",
			"fansCount": 0,
			"followCount": 0,
			"homepageBg": "",
			"id": 0,
			"showFansList": 0,
			"showFollowList": 0,
			"userAccount": "",
			"userAvatar": "",
			"userName": "",
			"userProfile": "",
			"userRole": ""
		},
		"userId": 0,
		"viewCount": 0
	},
	"message": ""
}

uploadPictureByUrl

接口地址:/picture/upload/url

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "categoryName": "",
  "fileUrl": "",
  "id": 0,
  "introduction": "",
  "picName": "",
  "spaceId": 0,
  "tagName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pictureUploadRequest	pictureUploadRequest	body	true	PictureUploadRequest	PictureUploadRequest
categoryName			false	string
fileUrl			false	string
id			false	integer(int64)
introduction			false	string
picName			false	string
spaceId			false	integer(int64)
tagName			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«PictureVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	PictureVO	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer(int64)
commentCount	integer(int64)
createTime	string(date-time)
editTime	string(date-time)
favoriteCount	integer(int64)
id	integer(int64)
introduction	string
isDownload	integer(int32)
isFavorited	integer(int32)
isFeature	integer(int32)
isLiked	integer(int32)
isShared	integer(int32)
likeCount	integer(int64)
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer(int32)
picScale	number(double)
picSize	integer(int64)
picWidth	integer(int32)
recommendScore	number(double)
reviewMessage	string
reviewStatus	integer(int32)
shareCount	integer(int64)
spaceId	integer(int64)
tags	array	string
thumbnailUrl	string
updateTime	string(date-time)
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"allowCollect": true,
		"allowComment": true,
		"allowLike": true,
		"allowShare": true,
		"category": "",
		"chatCount": 0,
		"commentCount": 0,
		"createTime": "",
		"editTime": "",
		"favoriteCount": 0,
		"id": 0,
		"introduction": "",
		"isDownload": 0,
		"isFavorited": 0,
		"isFeature": 0,
		"isLiked": 0,
		"isShared": 0,
		"likeCount": 0,
		"name": "",
		"permissionList": [],
		"picColor": "",
		"picFormat": "",
		"picHeight": 0,
		"picScale": 0,
		"picSize": 0,
		"picWidth": 0,
		"recommendScore": 0,
		"reviewMessage": "",
		"reviewStatus": 0,
		"shareCount": 0,
		"spaceId": 0,
		"tags": [],
		"thumbnailUrl": "",
		"updateTime": "",
		"url": "",
		"user": {
			"allowFollow": 0,
			"allowPrivateChat": 0,
			"createTime": "",
			"email": "",
			"fansCount": 0,
			"followCount": 0,
			"homepageBg": "",
			"id": 0,
			"showFansList": 0,
			"showFollowList": 0,
			"userAccount": "",
			"userAvatar": "",
			"userName": "",
			"userProfile": "",
			"userRole": ""
		},
		"userId": 0,
		"viewCount": 0
	},
	"message": ""
}

getUserAllPictures

接口地址:/picture/user/all

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
current	current	query	false	integer(int64)
size	size	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«Picture»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«Picture»	Page«Picture»
current	integer(int64)
pages	integer(int64)
records	array	Picture
allowCollect	integer
allowComment	integer
allowLike	integer
allowShare	integer
category	string
commentCount	integer
createTime	string
editTime	string
favoriteCount	integer
hotScore	number
id	integer
introduction	string
isDelete	integer
isDownload	integer
isDraft	integer
isFeature	integer
likeCount	integer
name	string
picColor	string
picFormat	string
picHeight	integer
picScale	number
picSize	integer
picWidth	integer
recommendScore	number
reviewMessage	string
reviewStatus	integer
reviewTime	string
reviewerId	integer
shareCount	integer
spaceId	integer
tags	string
thumbnailUrl	string
updateTime	string
url	string
userId	integer
viewCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"allowCollect": 0,
				"allowComment": 0,
				"allowLike": 0,
				"allowShare": 0,
				"category": "",
				"commentCount": 0,
				"createTime": "",
				"editTime": "",
				"favoriteCount": 0,
				"hotScore": 0,
				"id": 0,
				"introduction": "",
				"isDelete": 0,
				"isDownload": 0,
				"isDraft": 0,
				"isFeature": 0,
				"likeCount": 0,
				"name": "",
				"picColor": "",
				"picFormat": "",
				"picHeight": 0,
				"picScale": 0,
				"picSize": 0,
				"picWidth": 0,
				"recommendScore": 0,
				"reviewMessage": "",
				"reviewStatus": 0,
				"reviewTime": "",
				"reviewerId": 0,
				"shareCount": 0,
				"spaceId": 0,
				"tags": "",
				"thumbnailUrl": "",
				"updateTime": "",
				"url": "",
				"userId": 0,
				"viewCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

getUserPicturesFromOtherSpaces

接口地址:/picture/user/other-spaces

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
current	current	query	false	integer(int64)
size	size	query	false	integer(int64)
spaceId	spaceId	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«Picture»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«Picture»	Page«Picture»
current	integer(int64)
pages	integer(int64)
records	array	Picture
allowCollect	integer
allowComment	integer
allowLike	integer
allowShare	integer
category	string
commentCount	integer
createTime	string
editTime	string
favoriteCount	integer
hotScore	number
id	integer
introduction	string
isDelete	integer
isDownload	integer
isDraft	integer
isFeature	integer
likeCount	integer
name	string
picColor	string
picFormat	string
picHeight	integer
picScale	number
picSize	integer
picWidth	integer
recommendScore	number
reviewMessage	string
reviewStatus	integer
reviewTime	string
reviewerId	integer
shareCount	integer
spaceId	integer
tags	string
thumbnailUrl	string
updateTime	string
url	string
userId	integer
viewCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"allowCollect": 0,
				"allowComment": 0,
				"allowLike": 0,
				"allowShare": 0,
				"category": "",
				"commentCount": 0,
				"createTime": "",
				"editTime": "",
				"favoriteCount": 0,
				"hotScore": 0,
				"id": 0,
				"introduction": "",
				"isDelete": 0,
				"isDownload": 0,
				"isDraft": 0,
				"isFeature": 0,
				"likeCount": 0,
				"name": "",
				"picColor": "",
				"picFormat": "",
				"picHeight": 0,
				"picScale": 0,
				"picSize": 0,
				"picWidth": 0,
				"recommendScore": 0,
				"reviewMessage": "",
				"reviewStatus": 0,
				"reviewTime": "",
				"reviewerId": 0,
				"shareCount": 0,
				"spaceId": 0,
				"tags": "",
				"thumbnailUrl": "",
				"updateTime": "",
				"url": "",
				"userId": 0,
				"viewCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

post-controller

addPost

接口地址:/post/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "category": "",
  "content": "",
  "coverUrl": "",
  "id": 0,
  "tags": [],
  "title": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
postAddRequest	postAddRequest	body	true	PostAddRequest	PostAddRequest
category			false	string
content			false	string
coverUrl			false	string
id			false	integer(int64)
tags			false	array	string
title			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

deletePost

接口地址:/post/delete/{id}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getPostLatestDraft

接口地址:/post/draft/latest

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«PostVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	PostVO	PostVO
allowCollect	integer(int32)
allowComment	integer(int32)
allowLike	integer(int32)
allowShare	integer(int32)
category	string
commentCount	integer(int64)
content	string
coverUrl	string
createTime	string(date-time)
favoriteCount	integer(int64)
hotScore	number(double)
id	integer(int64)
isDraft	integer(int32)
isFavorited	integer(int32)
isLiked	integer(int32)
isShared	integer(int32)
likeCount	integer(int64)
reviewMessage	string
shareCount	integer(int64)
status	integer(int32)
tagList	array	string
tags	string
title	string
updateTime	string(date-time)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"allowCollect": 0,
		"allowComment": 0,
		"allowLike": 0,
		"allowShare": 0,
		"category": "",
		"commentCount": 0,
		"content": "",
		"coverUrl": "",
		"createTime": "",
		"favoriteCount": 0,
		"hotScore": 0,
		"id": 0,
		"isDraft": 0,
		"isFavorited": 0,
		"isLiked": 0,
		"isShared": 0,
		"likeCount": 0,
		"reviewMessage": "",
		"shareCount": 0,
		"status": 0,
		"tagList": [],
		"tags": "",
		"title": "",
		"updateTime": "",
		"user": {
			"allowFollow": 0,
			"allowPrivateChat": 0,
			"createTime": "",
			"email": "",
			"fansCount": 0,
			"followCount": 0,
			"homepageBg": "",
			"id": 0,
			"showFansList": 0,
			"showFollowList": 0,
			"userAccount": "",
			"userAvatar": "",
			"userName": "",
			"userProfile": "",
			"userRole": ""
		},
		"userId": 0,
		"viewCount": 0
	},
	"message": ""
}

listPostDrafts

接口地址:/post/draft/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«PostVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	PostVO
allowCollect	integer(int32)
allowComment	integer(int32)
allowLike	integer(int32)
allowShare	integer(int32)
category	string
commentCount	integer(int64)
content	string
coverUrl	string
createTime	string(date-time)
favoriteCount	integer(int64)
hotScore	number(double)
id	integer(int64)
isDraft	integer(int32)
isFavorited	integer(int32)
isLiked	integer(int32)
isShared	integer(int32)
likeCount	integer(int64)
reviewMessage	string
shareCount	integer(int64)
status	integer(int32)
tagList	array	string
tags	string
title	string
updateTime	string(date-time)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"allowCollect": 0,
			"allowComment": 0,
			"allowLike": 0,
			"allowShare": 0,
			"category": "",
			"commentCount": 0,
			"content": "",
			"coverUrl": "",
			"createTime": "",
			"favoriteCount": 0,
			"hotScore": 0,
			"id": 0,
			"isDraft": 0,
			"isFavorited": 0,
			"isLiked": 0,
			"isShared": 0,
			"likeCount": 0,
			"reviewMessage": "",
			"shareCount": 0,
			"status": 0,
			"tagList": [],
			"tags": "",
			"title": "",
			"updateTime": "",
			"user": {
				"allowFollow": 0,
				"allowPrivateChat": 0,
				"createTime": "",
				"email": "",
				"fansCount": 0,
				"followCount": 0,
				"homepageBg": "",
				"id": 0,
				"showFansList": 0,
				"showFollowList": 0,
				"userAccount": "",
				"userAvatar": "",
				"userName": "",
				"userProfile": "",
				"userRole": ""
			},
			"userId": 0,
			"viewCount": 0
		}
	],
	"message": ""
}

savePostDraft

接口地址:/post/draft/save

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "category": "",
  "content": "",
  "coverUrl": "",
  "id": 0,
  "tags": [],
  "title": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
postAddRequest	postAddRequest	body	true	PostAddRequest	PostAddRequest
category			false	string
content			false	string
coverUrl			false	string
id			false	integer(int64)
tags			false	array	string
title			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

deletePostDraft

接口地址:/post/draft/{draftId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
draftId	draftId	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getFollowPosts

接口地址:/post/follow

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "category": "",
  "current": 0,
  "isPublic": true,
  "pageSize": 0,
  "searchText": "",
  "sortField": "",
  "sortOrder": "",
  "status": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
postQueryRequest	postQueryRequest	body	true	PostQueryRequest	PostQueryRequest
category			false	string
current			false	integer(int32)
isPublic			false	boolean
pageSize			false	integer(int32)
searchText			false	string
sortField			false	string
sortOrder			false	string
status			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«PostVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«PostVO»	Page«PostVO»
current	integer(int64)
pages	integer(int64)
records	array	PostVO
allowCollect	integer
allowComment	integer
allowLike	integer
allowShare	integer
category	string
commentCount	integer
content	string
coverUrl	string
createTime	string
favoriteCount	integer
hotScore	number
id	integer
isDraft	integer
isFavorited	integer
isLiked	integer
isShared	integer
likeCount	integer
reviewMessage	string
shareCount	integer
status	integer
tagList	array	string
tags	string
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"allowCollect": 0,
				"allowComment": 0,
				"allowLike": 0,
				"allowShare": 0,
				"category": "",
				"commentCount": 0,
				"content": "",
				"coverUrl": "",
				"createTime": "",
				"favoriteCount": 0,
				"hotScore": 0,
				"id": 0,
				"isDraft": 0,
				"isFavorited": 0,
				"isLiked": 0,
				"isShared": 0,
				"likeCount": 0,
				"reviewMessage": "",
				"shareCount": 0,
				"status": 0,
				"tagList": [],
				"tags": "",
				"title": "",
				"updateTime": "",
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				},
				"userId": 0,
				"viewCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

getPostById

接口地址:/post/get/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«PostVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	PostVO	PostVO
allowCollect	integer(int32)
allowComment	integer(int32)
allowLike	integer(int32)
allowShare	integer(int32)
category	string
commentCount	integer(int64)
content	string
coverUrl	string
createTime	string(date-time)
favoriteCount	integer(int64)
hotScore	number(double)
id	integer(int64)
isDraft	integer(int32)
isFavorited	integer(int32)
isLiked	integer(int32)
isShared	integer(int32)
likeCount	integer(int64)
reviewMessage	string
shareCount	integer(int64)
status	integer(int32)
tagList	array	string
tags	string
title	string
updateTime	string(date-time)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"allowCollect": 0,
		"allowComment": 0,
		"allowLike": 0,
		"allowShare": 0,
		"category": "",
		"commentCount": 0,
		"content": "",
		"coverUrl": "",
		"createTime": "",
		"favoriteCount": 0,
		"hotScore": 0,
		"id": 0,
		"isDraft": 0,
		"isFavorited": 0,
		"isLiked": 0,
		"isShared": 0,
		"likeCount": 0,
		"reviewMessage": "",
		"shareCount": 0,
		"status": 0,
		"tagList": [],
		"tags": "",
		"title": "",
		"updateTime": "",
		"user": {
			"allowFollow": 0,
			"allowPrivateChat": 0,
			"createTime": "",
			"email": "",
			"fansCount": 0,
			"followCount": 0,
			"homepageBg": "",
			"id": 0,
			"showFansList": 0,
			"showFollowList": 0,
			"userAccount": "",
			"userAvatar": "",
			"userName": "",
			"userProfile": "",
			"userRole": ""
		},
		"userId": 0,
		"viewCount": 0
	},
	"message": ""
}

likePost

接口地址:/post/like/{id}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

listPostByPage

接口地址:/post/list/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "category": "",
  "current": 0,
  "isPublic": true,
  "pageSize": 0,
  "searchText": "",
  "sortField": "",
  "sortOrder": "",
  "status": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
postQueryRequest	postQueryRequest	body	true	PostQueryRequest	PostQueryRequest
category			false	string
current			false	integer(int32)
isPublic			false	boolean
pageSize			false	integer(int32)
searchText			false	string
sortField			false	string
sortOrder			false	string
status			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«PostVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«PostVO»	Page«PostVO»
current	integer(int64)
pages	integer(int64)
records	array	PostVO
allowCollect	integer
allowComment	integer
allowLike	integer
allowShare	integer
category	string
commentCount	integer
content	string
coverUrl	string
createTime	string
favoriteCount	integer
hotScore	number
id	integer
isDraft	integer
isFavorited	integer
isLiked	integer
isShared	integer
likeCount	integer
reviewMessage	string
shareCount	integer
status	integer
tagList	array	string
tags	string
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"allowCollect": 0,
				"allowComment": 0,
				"allowLike": 0,
				"allowShare": 0,
				"category": "",
				"commentCount": 0,
				"content": "",
				"coverUrl": "",
				"createTime": "",
				"favoriteCount": 0,
				"hotScore": 0,
				"id": 0,
				"isDraft": 0,
				"isFavorited": 0,
				"isLiked": 0,
				"isShared": 0,
				"likeCount": 0,
				"reviewMessage": "",
				"shareCount": 0,
				"status": 0,
				"tagList": [],
				"tags": "",
				"title": "",
				"updateTime": "",
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				},
				"userId": 0,
				"viewCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listMyPosts

接口地址:/post/my/list

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "category": "",
  "current": 0,
  "isPublic": true,
  "pageSize": 0,
  "searchText": "",
  "sortField": "",
  "sortOrder": "",
  "status": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
postQueryRequest	postQueryRequest	body	true	PostQueryRequest	PostQueryRequest
category			false	string
current			false	integer(int32)
isPublic			false	boolean
pageSize			false	integer(int32)
searchText			false	string
sortField			false	string
sortOrder			false	string
status			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«PostVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«PostVO»	Page«PostVO»
current	integer(int64)
pages	integer(int64)
records	array	PostVO
allowCollect	integer
allowComment	integer
allowLike	integer
allowShare	integer
category	string
commentCount	integer
content	string
coverUrl	string
createTime	string
favoriteCount	integer
hotScore	number
id	integer
isDraft	integer
isFavorited	integer
isLiked	integer
isShared	integer
likeCount	integer
reviewMessage	string
shareCount	integer
status	integer
tagList	array	string
tags	string
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"allowCollect": 0,
				"allowComment": 0,
				"allowLike": 0,
				"allowShare": 0,
				"category": "",
				"commentCount": 0,
				"content": "",
				"coverUrl": "",
				"createTime": "",
				"favoriteCount": 0,
				"hotScore": 0,
				"id": 0,
				"isDraft": 0,
				"isFavorited": 0,
				"isLiked": 0,
				"isShared": 0,
				"likeCount": 0,
				"reviewMessage": "",
				"shareCount": 0,
				"status": 0,
				"tagList": [],
				"tags": "",
				"title": "",
				"updateTime": "",
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				},
				"userId": 0,
				"viewCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

checkPostPermission

接口地址:/post/permission/check

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
operation	operation	query	true	string
postId	postId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

setPostPermission

接口地址:/post/permission/set

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "allowCollect": 0,
  "allowComment": 0,
  "allowLike": 0,
  "allowShare": 0,
  "postId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
permissionRequest	permissionRequest	body	true	PostPermissionRequest	PostPermissionRequest
allowCollect			false	integer(int32)
allowComment			false	integer(int32)
allowLike			false	integer(int32)
allowShare			false	integer(int32)
postId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

reviewPost

接口地址:/post/review/{id}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	id	path	true	integer(int64)
status	status	query	true	integer(int32)
message	message	query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

listPostTagCategory

接口地址:/post/tag_category

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«PostTagCategory»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	PostTagCategory	PostTagCategory
categoryList	array	string
tagList	array	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"categoryList": [],
		"tagList": []
	},
	"message": ""
}

getTop100Post

接口地址:/post/top100/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«PostVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	PostVO
allowCollect	integer(int32)
allowComment	integer(int32)
allowLike	integer(int32)
allowShare	integer(int32)
category	string
commentCount	integer(int64)
content	string
coverUrl	string
createTime	string(date-time)
favoriteCount	integer(int64)
hotScore	number(double)
id	integer(int64)
isDraft	integer(int32)
isFavorited	integer(int32)
isLiked	integer(int32)
isShared	integer(int32)
likeCount	integer(int64)
reviewMessage	string
shareCount	integer(int64)
status	integer(int32)
tagList	array	string
tags	string
title	string
updateTime	string(date-time)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"allowCollect": 0,
			"allowComment": 0,
			"allowLike": 0,
			"allowShare": 0,
			"category": "",
			"commentCount": 0,
			"content": "",
			"coverUrl": "",
			"createTime": "",
			"favoriteCount": 0,
			"hotScore": 0,
			"id": 0,
			"isDraft": 0,
			"isFavorited": 0,
			"isLiked": 0,
			"isShared": 0,
			"likeCount": 0,
			"reviewMessage": "",
			"shareCount": 0,
			"status": 0,
			"tagList": [],
			"tags": "",
			"title": "",
			"updateTime": "",
			"user": {
				"allowFollow": 0,
				"allowPrivateChat": 0,
				"createTime": "",
				"email": "",
				"fansCount": 0,
				"followCount": 0,
				"homepageBg": "",
				"id": 0,
				"showFansList": 0,
				"showFollowList": 0,
				"userAccount": "",
				"userAvatar": "",
				"userName": "",
				"userProfile": "",
				"userRole": ""
			},
			"userId": 0,
			"viewCount": 0
		}
	],
	"message": ""
}

updatePost

接口地址:/post/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "allowCollect": 0,
  "allowComment": 0,
  "allowLike": 0,
  "allowShare": 0,
  "category": "",
  "commentCount": 0,
  "content": "",
  "coverUrl": "",
  "createTime": "",
  "favoriteCount": 0,
  "hotScore": 0,
  "id": 0,
  "isDelete": 0,
  "isDraft": 0,
  "likeCount": 0,
  "reviewMessage": "",
  "shareCount": 0,
  "status": 0,
  "tags": "",
  "title": "",
  "updateTime": "",
  "user": {
    "allowFollow": 0,
    "allowPrivateChat": 0,
    "createTime": "",
    "email": "",
    "fansCount": 0,
    "followCount": 0,
    "homepageBg": "",
    "id": 0,
    "showFansList": 0,
    "showFollowList": 0,
    "userAccount": "",
    "userAvatar": "",
    "userName": "",
    "userProfile": "",
    "userRole": ""
  },
  "userId": 0,
  "viewCount": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
post	post	body	true	Post	Post
allowCollect			false	integer(int32)
allowComment			false	integer(int32)
allowLike			false	integer(int32)
allowShare			false	integer(int32)
category			false	string
commentCount			false	integer(int64)
content			false	string
coverUrl			false	string
createTime			false	string(date-time)
favoriteCount			false	integer(int64)
hotScore			false	number(double)
id			false	integer(int64)
isDelete			false	integer(int32)
isDraft			false	integer(int32)
likeCount			false	integer(int64)
reviewMessage			false	string
shareCount			false	integer(int64)
status			false	integer(int32)
tags			false	string
title			false	string
updateTime			false	string(date-time)
user			false	UserVO	UserVO
allowFollow			false	integer
allowPrivateChat			false	integer
createTime			false	string
email			false	string
fansCount			false	integer
followCount			false	integer
homepageBg			false	string
id			false	integer
showFansList			false	integer
showFollowList			false	integer
userAccount			false	string
userAvatar			false	string
userName			false	string
userProfile			false	string
userRole			false	string
userId			false	integer(int64)
viewCount			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

private-chat-controller

clearUnreadCount

接口地址:/private_chat/clear_unread/{targetUserId}/{isSender}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
isSender	isSender	path	true	boolean
targetUserId	targetUserId	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

createOrUpdatePrivateChat

接口地址:/private_chat/create_update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
targetUserId	targetUserId	query	true	integer(int64)
lastMessage	lastMessage	query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«PrivateChat»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	PrivateChat	PrivateChat
chatType	integer(int32)
createTime	string(date-time)
id	integer(int64)
isDelete	integer(int32)
isSender	boolean
lastMessage	string
lastMessageTime	string(date-time)
targetUser	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
targetUserChatName	string
targetUserId	integer(int64)
targetUserUnreadCount	integer(int32)
updateTime	string(date-time)
userChatName	string
userId	integer(int64)
userUnreadCount	integer(int32)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"chatType": 0,
		"createTime": "",
		"id": 0,
		"isDelete": 0,
		"isSender": true,
		"lastMessage": "",
		"lastMessageTime": "",
		"targetUser": {
			"allowFollow": 0,
			"allowPrivateChat": 0,
			"createTime": "",
			"email": "",
			"fansCount": 0,
			"followCount": 0,
			"homepageBg": "",
			"id": 0,
			"showFansList": 0,
			"showFollowList": 0,
			"userAccount": "",
			"userAvatar": "",
			"userName": "",
			"userProfile": "",
			"userRole": ""
		},
		"targetUserChatName": "",
		"targetUserId": 0,
		"targetUserUnreadCount": 0,
		"updateTime": "",
		"userChatName": "",
		"userId": 0,
		"userUnreadCount": 0
	},
	"message": ""
}

deletePrivateChat

接口地址:/private_chat/delete/{privateChatId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
privateChatId	privateChatId	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

listPrivateChatByPage

接口地址:/private_chat/list/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "chatType": 0,
  "current": 0,
  "pageSize": 0,
  "searchText": "",
  "sortField": "",
  "sortOrder": "",
  "targetUserId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
privateChatQueryRequest	privateChatQueryRequest	body	true	PrivateChatQueryRequest	PrivateChatQueryRequest
chatType			false	integer(int32)
current			false	integer(int32)
pageSize			false	integer(int32)
searchText			false	string
sortField			false	string
sortOrder			false	string
targetUserId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«PrivateChat»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«PrivateChat»	Page«PrivateChat»
current	integer(int64)
pages	integer(int64)
records	array	PrivateChat
chatType	integer
createTime	string
id	integer
isDelete	integer
isSender	boolean
lastMessage	string
lastMessageTime	string
targetUser	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
targetUserChatName	string
targetUserId	integer
targetUserUnreadCount	integer
updateTime	string
userChatName	string
userId	integer
userUnreadCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"chatType": 0,
				"createTime": "",
				"id": 0,
				"isDelete": 0,
				"isSender": true,
				"lastMessage": "",
				"lastMessageTime": "",
				"targetUser": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				},
				"targetUserChatName": "",
				"targetUserId": 0,
				"targetUserUnreadCount": 0,
				"updateTime": "",
				"userChatName": "",
				"userId": 0,
				"userUnreadCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

updateChatName

接口地址:/private_chat/update_name/{privateChatId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
chatName	chatName	query	true	string
privateChatId	privateChatId	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

updateChatType

接口地址:/private_chat/update_type/{targetUserId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
isFriend	isFriend	query	true	boolean
targetUserId	targetUserId	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

rag-controller

chat

接口地址:/rag/chat

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
question	question	query	true	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«RagChatResponse»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	RagChatResponse	RagChatResponse
answer	string
cacheHit	boolean
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"answer": "",
		"cacheHit": true
	},
	"message": ""
}

chatStream

接口地址:/rag/chat/stream

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:text/event-stream

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
question	question	query	true	string

响应状态:

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

响应参数:

参数名称	参数说明	类型	schema
timeout		integer(int64)	integer(int64)

响应示例:

javascript

{
	"timeout": 0
}

clearContext

接口地址:/rag/clearContext

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

redis-cache-monitor-controller

getRedisInfo

接口地址:/monitor/cache/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Map«string,object»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
message	string

响应示例:

javascript

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

getKeysStatistics

接口地址:/monitor/cache/keys

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Map«string,object»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
message	string

响应示例:

javascript

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

getMemoryInfo

接口地址:/monitor/cache/memory

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Map«string,object»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
message	string

响应示例:

javascript

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

reminder-controller

addReminder

接口地址:/reminder/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "content": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
reminderAddRequest	reminderAddRequest	body	true	ReminderAddRequest	ReminderAddRequest
content			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

deleteReminder

接口地址:/reminder/delete/{id}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

toggleImportant

接口地址:/reminder/important/{id}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

listReminderByPage

接口地址:/reminder/list/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "completed": true,
  "current": 0,
  "date": "",
  "important": true,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "starred": true
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
reminderQueryRequest	reminderQueryRequest	body	true	ReminderQueryRequest	ReminderQueryRequest
completed			false	boolean
current			false	integer(int32)
date			false	string(date)
important			false	boolean
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
starred			false	boolean

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«ReminderVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«ReminderVO»	Page«ReminderVO»
current	integer(int64)
pages	integer(int64)
records	array	ReminderVO
completed	boolean
content	string
id	integer
important	boolean
starred	boolean
time	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"completed": true,
				"content": "",
				"id": 0,
				"important": true,
				"starred": true,
				"time": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

toggleStarred

接口地址:/reminder/star/{id}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getTodayReminders

接口地址:/reminder/today

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "completed": true,
  "current": 0,
  "date": "",
  "important": true,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "starred": true
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
reminderQueryRequest	reminderQueryRequest	body	true	ReminderQueryRequest	ReminderQueryRequest
completed			false	boolean
current			false	integer(int32)
date			false	string(date)
important			false	boolean
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
starred			false	boolean

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«ReminderVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«ReminderVO»	Page«ReminderVO»
current	integer(int64)
pages	integer(int64)
records	array	ReminderVO
completed	boolean
content	string
id	integer
important	boolean
starred	boolean
time	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"completed": true,
				"content": "",
				"id": 0,
				"important": true,
				"starred": true,
				"time": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

toggleReminder

接口地址:/reminder/toggle/{id}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

report-controller

addReport

接口地址:/report/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "reason": "",
  "reportType": 0,
  "screenshotUrls": [],
  "targetId": 0,
  "targetType": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
reportAddRequest	reportAddRequest	body	true	ReportAddRequest	ReportAddRequest
reason			false	string
reportType			false	integer(int32)
screenshotUrls			false	array	string
targetId			false	integer(int64)
targetType			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

deleteReport

接口地址:/report/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "id": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deleteRequest	deleteRequest	body	true	DeleteRequest	DeleteRequest
id			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getReportById

接口地址:/report/get

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«ReportVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	ReportVO	ReportVO
createTime	string(date-time)
handleResult	string
handleTime	string(date-time)
handlerId	integer(int64)
handlerName	string
id	integer(int64)
reason	string
reportType	integer(int32)
reportTypeText	string
screenshotUrls	array	string
status	integer(int32)
statusText	string
targetId	integer(int64)
targetType	integer(int32)
targetTypeText	string
updateTime	string(date-time)
userAvatar	string
userId	integer(int64)
userName	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"createTime": "",
		"handleResult": "",
		"handleTime": "",
		"handlerId": 0,
		"handlerName": "",
		"id": 0,
		"reason": "",
		"reportType": 0,
		"reportTypeText": "",
		"screenshotUrls": [],
		"status": 0,
		"statusText": "",
		"targetId": 0,
		"targetType": 0,
		"targetTypeText": "",
		"updateTime": "",
		"userAvatar": "",
		"userId": 0,
		"userName": ""
	},
	"message": ""
}

listReportByPage

接口地址:/report/list/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "id": 0,
  "pageSize": 0,
  "reportType": 0,
  "sortField": "",
  "sortOrder": "",
  "status": 0,
  "targetId": 0,
  "targetType": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
reportQueryRequest	reportQueryRequest	body	true	ReportQueryRequest	ReportQueryRequest
current			false	integer(int32)
id			false	integer(int64)
pageSize			false	integer(int32)
reportType			false	integer(int32)
sortField			false	string
sortOrder			false	string
status			false	integer(int32)
targetId			false	integer(int64)
targetType			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«ReportVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«ReportVO»	Page«ReportVO»
current	integer(int64)
pages	integer(int64)
records	array	ReportVO
createTime	string
handleResult	string
handleTime	string
handlerId	integer
handlerName	string
id	integer
reason	string
reportType	integer
reportTypeText	string
screenshotUrls	array	string
status	integer
statusText	string
targetId	integer
targetType	integer
targetTypeText	string
updateTime	string
userAvatar	string
userId	integer
userName	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"createTime": "",
				"handleResult": "",
				"handleTime": "",
				"handlerId": 0,
				"handlerName": "",
				"id": 0,
				"reason": "",
				"reportType": 0,
				"reportTypeText": "",
				"screenshotUrls": [],
				"status": 0,
				"statusText": "",
				"targetId": 0,
				"targetType": 0,
				"targetTypeText": "",
				"updateTime": "",
				"userAvatar": "",
				"userId": 0,
				"userName": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listMyReportByPage

接口地址:/report/my/list/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "id": 0,
  "pageSize": 0,
  "reportType": 0,
  "sortField": "",
  "sortOrder": "",
  "status": 0,
  "targetId": 0,
  "targetType": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
reportQueryRequest	reportQueryRequest	body	true	ReportQueryRequest	ReportQueryRequest
current			false	integer(int32)
id			false	integer(int64)
pageSize			false	integer(int32)
reportType			false	integer(int32)
sortField			false	string
sortOrder			false	string
status			false	integer(int32)
targetId			false	integer(int64)
targetType			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«ReportVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«ReportVO»	Page«ReportVO»
current	integer(int64)
pages	integer(int64)
records	array	ReportVO
createTime	string
handleResult	string
handleTime	string
handlerId	integer
handlerName	string
id	integer
reason	string
reportType	integer
reportTypeText	string
screenshotUrls	array	string
status	integer
statusText	string
targetId	integer
targetType	integer
targetTypeText	string
updateTime	string
userAvatar	string
userId	integer
userName	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"createTime": "",
				"handleResult": "",
				"handleTime": "",
				"handlerId": 0,
				"handlerName": "",
				"id": 0,
				"reason": "",
				"reportType": 0,
				"reportTypeText": "",
				"screenshotUrls": [],
				"status": 0,
				"statusText": "",
				"targetId": 0,
				"targetType": 0,
				"targetTypeText": "",
				"updateTime": "",
				"userAvatar": "",
				"userId": 0,
				"userName": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

updateReport

接口地址:/report/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "handleResult": "",
  "id": 0,
  "status": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
reportUpdateRequest	reportUpdateRequest	body	true	ReportUpdateRequest	ReportUpdateRequest
handleResult			false	string
id			false	integer(int64)
status			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

search-controller

searchAll

接口地址:/search/all

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "pageSize": 0,
  "searchText": "",
  "type": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
searchRequest	searchRequest	body	true	SearchRequest	SearchRequest
current			false	integer(int32)
pageSize			false	integer(int32)
searchText			false	string
type			false	string
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«object»»_1
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«object»_1	Page«object»_1
content	array	object
empty	boolean
first	boolean
last	boolean
number	integer(int32)
numberOfElements	integer(int32)
pageable	Pageable	Pageable
offset	integer
pageNumber	integer
pageSize	integer
paged	boolean
sort	Sort	Sort
empty	boolean
sorted	boolean
unsorted	boolean
unpaged	boolean
size	integer(int32)
sort	Sort	Sort
empty	boolean
sorted	boolean
unsorted	boolean
totalElements	integer(int64)
totalPages	integer(int32)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"content": [],
		"empty": true,
		"first": true,
		"last": true,
		"number": 0,
		"numberOfElements": 0,
		"pageable": {
			"offset": 0,
			"pageNumber": 0,
			"pageSize": 0,
			"paged": true,
			"sort": {
				"empty": true,
				"sorted": true,
				"unsorted": true
			},
			"unpaged": true
		},
		"size": 0,
		"sort": {
			"empty": true,
			"sorted": true,
			"unsorted": true
		},
		"totalElements": 0,
		"totalPages": 0
	},
	"message": ""
}

getGuessYouWantToSearch

接口地址:/search/guess

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
type	type	query	true	string
size	size	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«HotSearchVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	HotSearchVO
count	integer(int64)
keyword	string
realTimeCount	integer(int64)
reason	string
score	number(double)
trend	number(double)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"count": 0,
			"keyword": "",
			"realTimeCount": 0,
			"reason": "",
			"score": 0,
			"trend": 0
		}
	],
	"message": ""
}

getUserSearchHistory

接口地址:/search/history

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
type	type	query	true	string
userId	userId	query	true	integer(int64)
size	size	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«UserSearchRecord»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	UserSearchRecord
createTime	string(date-time)
id	integer(int64)
isDelete	integer(int32)
keyword	string
searchTime	string(date-time)
type	string
updateTime	string(date-time)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"createTime": "",
			"id": 0,
			"isDelete": 0,
			"keyword": "",
			"searchTime": "",
			"type": "",
			"updateTime": "",
			"userId": 0
		}
	],
	"message": ""
}

deleteUserSearchHistory

接口地址:/search/history

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
type	type	query	true	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getHotSearchKeywords

接口地址:/search/hot

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
type	type	query	true	string
size	size	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«HotSearchVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	HotSearchVO
count	integer(int64)
keyword	string
realTimeCount	integer(int64)
reason	string
score	number(double)
trend	number(double)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"count": 0,
			"keyword": "",
			"realTimeCount": 0,
			"reason": "",
			"score": 0,
			"trend": 0
		}
	],
	"message": ""
}

session-controller

createSession

接口地址:/rag/session/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "id": 0,
  "isActive": 0,
  "isDelete": 0,
  "pageSize": 0,
  "sessionName": "",
  "sortField": "",
  "sortOrder": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
sessionQueryRequest	sessionQueryRequest	body	false	SessionQueryRequest	SessionQueryRequest
current			false	integer(int32)
id			false	integer(int64)
isActive			false	integer(int32)
isDelete			false	integer(int32)
pageSize			false	integer(int32)
sessionName			false	string
sortField			false	string
sortOrder			false	string
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«RagSessionVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	RagSessionVO	RagSessionVO
createTime	string(date-time)
id	integer(int64)
isActive	integer(int32)
isDelete	integer(int32)
sessionName	string
updateTime	string(date-time)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"createTime": "",
		"id": 0,
		"isActive": 0,
		"isDelete": 0,
		"sessionName": "",
		"updateTime": "",
		"userId": 0
	},
	"message": ""
}

deleteSession

接口地址:/rag/session/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "sessionId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
sessionDeleteRequest	sessionDeleteRequest	body	true	SessionDeleteRequest	SessionDeleteRequest
sessionId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

deleteSessionById

接口地址:/rag/session/delete/admin

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "id": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deleteRequest	deleteRequest	body	true	DeleteRequest	DeleteRequest
id			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

deleteBatchSessions

接口地址:/rag/session/delete/batch

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

[
  {
    "id": 0
  }
]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deleteRequestList	deleteRequestList	body	true	array	DeleteRequest
id			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getSessionById

接口地址:/rag/session/get

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«RagSessionVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	RagSessionVO	RagSessionVO
createTime	string(date-time)
id	integer(int64)
isActive	integer(int32)
isDelete	integer(int32)
sessionName	string
updateTime	string(date-time)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"createTime": "",
		"id": 0,
		"isActive": 0,
		"isDelete": 0,
		"sessionName": "",
		"updateTime": "",
		"userId": 0
	},
	"message": ""
}

listSessions

接口地址:/rag/session/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	请求类型	是否必须	数据类型
current	query	false	integer(int32)
id	query	false	integer(int64)
isActive	query	false	integer(int32)
isDelete	query	false	integer(int32)
pageSize	query	false	integer(int32)
sessionName	query	false	string
sortField	query	false	string
sortOrder	query	false	string
userId	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«IPage«RagSessionVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	IPage«RagSessionVO»	IPage«RagSessionVO»
current	integer(int64)
pages	integer(int64)
records	array	RagSessionVO
createTime	string
id	integer
isActive	integer
isDelete	integer
sessionName	string
updateTime	string
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"createTime": "",
				"id": 0,
				"isActive": 0,
				"isDelete": 0,
				"sessionName": "",
				"updateTime": "",
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listSessionsByPage

接口地址:/rag/session/list/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "id": 0,
  "isActive": 0,
  "isDelete": 0,
  "pageSize": 0,
  "sessionName": "",
  "sortField": "",
  "sortOrder": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
sessionQueryRequest	sessionQueryRequest	body	false	SessionQueryRequest	SessionQueryRequest
current			false	integer(int32)
id			false	integer(int64)
isActive			false	integer(int32)
isDelete			false	integer(int32)
pageSize			false	integer(int32)
sessionName			false	string
sortField			false	string
sortOrder			false	string
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«IPage«RagSessionVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	IPage«RagSessionVO»	IPage«RagSessionVO»
current	integer(int64)
pages	integer(int64)
records	array	RagSessionVO
createTime	string
id	integer
isActive	integer
isDelete	integer
sessionName	string
updateTime	string
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"createTime": "",
				"id": 0,
				"isActive": 0,
				"isDelete": 0,
				"sessionName": "",
				"updateTime": "",
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

switchSession

接口地址:/rag/session/switch

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "sessionId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
sessionSwitchRequest	sessionSwitchRequest	body	true	SessionSwitchRequest	SessionSwitchRequest
sessionId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«RagSessionVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	RagSessionVO	RagSessionVO
createTime	string(date-time)
id	integer(int64)
isActive	integer(int32)
isDelete	integer(int32)
sessionName	string
updateTime	string(date-time)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"createTime": "",
		"id": 0,
		"isActive": 0,
		"isDelete": 0,
		"sessionName": "",
		"updateTime": "",
		"userId": 0
	},
	"message": ""
}

updateSessionName

接口地址:/rag/session/updateName

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "id": 0,
  "isActive": 0,
  "isDelete": 0,
  "pageSize": 0,
  "sessionName": "",
  "sortField": "",
  "sortOrder": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
sessionQueryRequest	sessionQueryRequest	body	true	SessionQueryRequest	SessionQueryRequest
current			false	integer(int32)
id			false	integer(int64)
isActive			false	integer(int32)
isDelete			false	integer(int32)
pageSize			false	integer(int32)
sessionName			false	string
sortField			false	string
sortOrder			false	string
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

batchOperationShares

接口地址:/share/batch

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "ids": [],
  "operation": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
shareBatchRequest	shareBatchRequest	body	true	ShareBatchRequest	ShareBatchRequest
ids			false	array	integer(int64)
operation			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

doShare

接口地址:/share/do

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "isShared": true,
  "targetId": 0,
  "targetType": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
shareRequest	shareRequest	body	true	ShareRequest	ShareRequest
isShared			false	boolean
targetId			false	integer(int64)
targetType			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getShareById

接口地址:/share/get

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«ShareRecord»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	ShareRecord	ShareRecord
id	integer(int64)
isRead	integer(int32)
isShared	boolean
shareTime	string(date-time)
targetId	integer(int64)
targetType	integer(int32)
targetUserId	integer(int64)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"id": 0,
		"isRead": 0,
		"isShared": true,
		"shareTime": "",
		"targetId": 0,
		"targetType": 0,
		"targetUserId": 0,
		"userId": 0
	},
	"message": ""
}

getShareHistory

接口地址:/share/history

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "targetType": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
shareQueryRequest	shareQueryRequest	body	true	ShareQueryRequest	ShareQueryRequest
current			false	integer(int32)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
targetType			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«ShareRecordVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«ShareRecordVO»	Page«ShareRecordVO»
current	integer(int64)
pages	integer(int64)
records	array	ShareRecordVO
id	integer
isRead	integer
shareTime	string
target	object
targetType	integer
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"id": 0,
				"isRead": 0,
				"shareTime": "",
				"target": {},
				"targetType": 0,
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				}
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listSharesByPage

接口地址:/share/list/page/admin

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "id": 0,
  "isRead": 0,
  "isShared": true,
  "pageSize": 0,
  "shareTime": "",
  "sortField": "",
  "sortOrder": "",
  "targetId": 0,
  "targetType": 0,
  "targetUserId": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
shareAdminRequest	shareAdminRequest	body	true	ShareAdminRequest	ShareAdminRequest
current			false	integer(int32)
id			false	integer(int64)
isRead			false	integer(int32)
isShared			false	boolean
pageSize			false	integer(int32)
shareTime			false	string(date-time)
sortField			false	string
sortOrder			false	string
targetId			false	integer(int64)
targetType			false	integer(int32)
targetUserId			false	integer(int64)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«ShareRecord»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«ShareRecord»	Page«ShareRecord»
current	integer(int64)
pages	integer(int64)
records	array	ShareRecord
id	integer
isRead	integer
isShared	boolean
shareTime	string
targetId	integer
targetType	integer
targetUserId	integer
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"id": 0,
				"isRead": 0,
				"isShared": true,
				"shareTime": "",
				"targetId": 0,
				"targetType": 0,
				"targetUserId": 0,
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

getMyShareHistory

接口地址:/share/my/history

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "targetType": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
shareQueryRequest	shareQueryRequest	body	true	ShareQueryRequest	ShareQueryRequest
current			false	integer(int32)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
targetType			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«ShareRecordVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«ShareRecordVO»	Page«ShareRecordVO»
current	integer(int64)
pages	integer(int64)
records	array	ShareRecordVO
id	integer
isRead	integer
shareTime	string
target	object
targetType	integer
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"id": 0,
				"isRead": 0,
				"shareTime": "",
				"target": {},
				"targetType": 0,
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				}
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

getShareStatus

接口地址:/share/status/{targetType}/{targetId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
targetId	targetId	path	true	integer(int64)
targetType	targetType	path	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getUnreadShares

接口地址:/share/unread

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«ShareRecordVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	ShareRecordVO
id	integer(int64)
isRead	integer(int32)
shareTime	string(date-time)
target	object
targetType	integer(int32)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"id": 0,
			"isRead": 0,
			"shareTime": "",
			"target": {},
			"targetType": 0,
			"user": {
				"allowFollow": 0,
				"allowPrivateChat": 0,
				"createTime": "",
				"email": "",
				"fansCount": 0,
				"followCount": 0,
				"homepageBg": "",
				"id": 0,
				"showFansList": 0,
				"showFollowList": 0,
				"userAccount": "",
				"userAvatar": "",
				"userName": "",
				"userProfile": "",
				"userRole": ""
			}
		}
	],
	"message": ""
}

getUnreadSharesCount

接口地址:/share/unread/count

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

updateShare

接口地址:/share/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "id": 0,
  "isRead": 0,
  "isShared": true,
  "shareTime": "",
  "targetId": 0,
  "targetType": 0,
  "targetUserId": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
share	share	body	true	ShareRecord	ShareRecord
id			false	integer(int64)
isRead			false	integer(int32)
isShared			false	boolean
shareTime			false	string(date-time)
targetId			false	integer(int64)
targetType			false	integer(int32)
targetUserId			false	integer(int64)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

snake-game-controller

getUserAllHighestScores

接口地址:/snake/highest/all

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«UserHighestScoreVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	UserHighestScoreVO	UserHighestScoreVO
classicModeScore	integer(int32)
noWallModeScore	integer(int32)
speedModeScore	integer(int32)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"classicModeScore": 0,
		"noWallModeScore": 0,
		"speedModeScore": 0
	},
	"message": ""
}

getRankingList

接口地址:/snake/ranking

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "gameMode": 0,
  "limit": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
request	request	body	true	GameRankingRequest	GameRankingRequest
gameMode			false	integer(int32)
limit			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«SnakeGameRecord»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	SnakeGameRecord
createTime	string(date-time)
foodCount	integer(int32)
gameMode	integer(int32)
gameTime	integer(int32)
id	integer(int64)
isDelete	integer(int32)
score	integer(int32)
snakeLength	integer(int32)
updateTime	string(date-time)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"createTime": "",
			"foodCount": 0,
			"gameMode": 0,
			"gameTime": 0,
			"id": 0,
			"isDelete": 0,
			"score": 0,
			"snakeLength": 0,
			"updateTime": "",
			"userId": 0
		}
	],
	"message": ""
}

saveGameRecord

接口地址:/snake/save

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "foodCount": 0,
  "gameMode": 0,
  "gameTime": 0,
  "score": 0,
  "snakeLength": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
request	request	body	true	SaveGameRecordRequest_1	SaveGameRecordRequest_1
foodCount			false	integer(int32)
gameMode			false	integer(int32)
gameTime			false	integer(int32)
score			false	integer(int32)
snakeLength			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«SnakeGameRecord»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	SnakeGameRecord	SnakeGameRecord
createTime	string(date-time)
foodCount	integer(int32)
gameMode	integer(int32)
gameTime	integer(int32)
id	integer(int64)
isDelete	integer(int32)
score	integer(int32)
snakeLength	integer(int32)
updateTime	string(date-time)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"createTime": "",
		"foodCount": 0,
		"gameMode": 0,
		"gameTime": 0,
		"id": 0,
		"isDelete": 0,
		"score": 0,
		"snakeLength": 0,
		"updateTime": "",
		"userId": 0
	},
	"message": ""
}

space-analyze-controller

getSpaceCategoryAnalyze

接口地址:/space/analyze/category

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "queryAll": true,
  "queryPublic": true,
  "spaceId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceCategoryAnalyzeRequest	spaceCategoryAnalyzeRequest	body	true	SpaceCategoryAnalyzeRequest	SpaceCategoryAnalyzeRequest
queryAll			false	boolean
queryPublic			false	boolean
spaceId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«SpaceCategoryAnalyzeResponse»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	SpaceCategoryAnalyzeResponse
category	string
count	integer(int64)
totalSize	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"category": "",
			"count": 0,
			"totalSize": 0
		}
	],
	"message": ""
}

getSpaceRankAnalyze

接口地址:/space/analyze/rank

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "topN": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceRankAnalyzeRequest	spaceRankAnalyzeRequest	body	true	SpaceRankAnalyzeRequest	SpaceRankAnalyzeRequest
topN			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«Space»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	Space
createTime	string(date-time)
editTime	string(date-time)
id	integer(int64)
isDelete	integer(int32)
isRecommended	integer(int32)
maxCount	integer(int64)
maxSize	integer(int64)
spaceCover	string
spaceDesc	string
spaceLevel	integer(int32)
spaceName	string
spaceType	integer(int32)
totalCount	integer(int64)
totalSize	integer(int64)
updateTime	string(date-time)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"createTime": "",
			"editTime": "",
			"id": 0,
			"isDelete": 0,
			"isRecommended": 0,
			"maxCount": 0,
			"maxSize": 0,
			"spaceCover": "",
			"spaceDesc": "",
			"spaceLevel": 0,
			"spaceName": "",
			"spaceType": 0,
			"totalCount": 0,
			"totalSize": 0,
			"updateTime": "",
			"userId": 0
		}
	],
	"message": ""
}

getSpaceSizeAnalyze

接口地址:/space/analyze/size

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "queryAll": true,
  "queryPublic": true,
  "spaceId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceSizeAnalyzeRequest	spaceSizeAnalyzeRequest	body	true	SpaceSizeAnalyzeRequest	SpaceSizeAnalyzeRequest
queryAll			false	boolean
queryPublic			false	boolean
spaceId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«SpaceSizeAnalyzeResponse»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	SpaceSizeAnalyzeResponse
count	integer(int64)
sizeRange	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"count": 0,
			"sizeRange": ""
		}
	],
	"message": ""
}

getSpaceTagAnalyze

接口地址:/space/analyze/tag

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "queryAll": true,
  "queryPublic": true,
  "spaceId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceTagAnalyzeRequest	spaceTagAnalyzeRequest	body	true	SpaceTagAnalyzeRequest	SpaceTagAnalyzeRequest
queryAll			false	boolean
queryPublic			false	boolean
spaceId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«SpaceTagAnalyzeResponse»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	SpaceTagAnalyzeResponse
count	integer(int64)
tag	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"count": 0,
			"tag": ""
		}
	],
	"message": ""
}

getSpaceUsageAnalyze

接口地址:/space/analyze/usage

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "queryAll": true,
  "queryPublic": true,
  "spaceId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceUsageAnalyzeRequest	spaceUsageAnalyzeRequest	body	true	SpaceUsageAnalyzeRequest	SpaceUsageAnalyzeRequest
queryAll			false	boolean
queryPublic			false	boolean
spaceId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«SpaceUsageAnalyzeResponse»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	SpaceUsageAnalyzeResponse	SpaceUsageAnalyzeResponse
countUsageRatio	number(double)
maxCount	integer(int64)
maxSize	integer(int64)
sizeUsageRatio	number(double)
usedCount	integer(int64)
usedSize	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"countUsageRatio": 0,
		"maxCount": 0,
		"maxSize": 0,
		"sizeUsageRatio": 0,
		"usedCount": 0,
		"usedSize": 0
	},
	"message": ""
}

getSpaceUserAnalyze

接口地址:/space/analyze/user

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "queryAll": true,
  "queryPublic": true,
  "spaceId": 0,
  "timeDimension": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceUserAnalyzeRequest	spaceUserAnalyzeRequest	body	true	SpaceUserAnalyzeRequest	SpaceUserAnalyzeRequest
queryAll			false	boolean
queryPublic			false	boolean
spaceId			false	integer(int64)
timeDimension			false	string
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«SpaceUserAnalyzeResponse»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	SpaceUserAnalyzeResponse
count	integer(int64)
period	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"count": 0,
			"period": ""
		}
	],
	"message": ""
}

space-controller

addSpace

接口地址:/space/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "spaceCover": "",
  "spaceDesc": "",
  "spaceLevel": 0,
  "spaceName": "",
  "spaceType": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceAddRequest	spaceAddRequest	body	true	SpaceAddRequest	SpaceAddRequest
spaceCover			false	string
spaceDesc			false	string
spaceLevel			false	integer(int32)
spaceName			false	string
spaceType			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

deleteSpace

接口地址:/space/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "id": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deleteRequest	deleteRequest	body	true	DeleteRequest	DeleteRequest
id			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

deleteBatchSpace

接口地址:/space/delete/batch

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

[
  {
    "id": 0
  }
]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deleteRequestList	deleteRequestList	body	true	array	DeleteRequest
id			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

editSpace

接口地址:/space/edit

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "id": 0,
  "spaceCover": "",
  "spaceDesc": "",
  "spaceName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceEditRequest	spaceEditRequest	body	true	SpaceEditRequest	SpaceEditRequest
id			false	integer(int64)
spaceCover			false	string
spaceDesc			false	string
spaceName			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getSpaceById

接口地址:/space/get

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Space»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Space	Space
createTime	string(date-time)
editTime	string(date-time)
id	integer(int64)
isDelete	integer(int32)
isRecommended	integer(int32)
maxCount	integer(int64)
maxSize	integer(int64)
spaceCover	string
spaceDesc	string
spaceLevel	integer(int32)
spaceName	string
spaceType	integer(int32)
totalCount	integer(int64)
totalSize	integer(int64)
updateTime	string(date-time)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"createTime": "",
		"editTime": "",
		"id": 0,
		"isDelete": 0,
		"isRecommended": 0,
		"maxCount": 0,
		"maxSize": 0,
		"spaceCover": "",
		"spaceDesc": "",
		"spaceLevel": 0,
		"spaceName": "",
		"spaceType": 0,
		"totalCount": 0,
		"totalSize": 0,
		"updateTime": "",
		"userId": 0
	},
	"message": ""
}

getSpaceVOById

接口地址:/space/get/vo

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«SpaceVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	SpaceVO	SpaceVO
activities	array	Activity
activityExpired	boolean
commentCount	integer
content	string
coverUrl	string
createTime	string
expireTime	string
id	integer
isDelete	integer
isExpired	integer
isLiked	integer
isShared	integer
likeCount	integer
reviewMessage	string
shareCount	integer
spaceId	integer
status	integer
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
createTime	string(date-time)
editTime	string(date-time)
id	integer(int64)
isRecommended	integer(int32)
maxCount	integer(int64)
maxSize	integer(int64)
memberCount	integer(int64)
permissionList	array	string
recommendedUsers	array	SpaceUserVO
createTime	string
id	integer
space	SpaceVO	SpaceVO
spaceId	integer
spaceRole	string
status	integer
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
spaceCover	string
spaceDesc	string
spaceLevel	integer(int32)
spaceName	string
spaceType	integer(int32)
totalCount	integer(int64)
totalSize	integer(int64)
updateTime	string(date-time)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"activities": [
			{
				"activityExpired": true,
				"commentCount": 0,
				"content": "",
				"coverUrl": "",
				"createTime": "",
				"expireTime": "",
				"id": 0,
				"isDelete": 0,
				"isExpired": 0,
				"isLiked": 0,
				"isShared": 0,
				"likeCount": 0,
				"reviewMessage": "",
				"shareCount": 0,
				"spaceId": 0,
				"status": 0,
				"title": "",
				"updateTime": "",
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				},
				"userId": 0,
				"viewCount": 0
			}
		],
		"createTime": "",
		"editTime": "",
		"id": 0,
		"isRecommended": 0,
		"maxCount": 0,
		"maxSize": 0,
		"memberCount": 0,
		"permissionList": [],
		"recommendedUsers": [
			{
				"createTime": "",
				"id": 0,
				"space": {},
				"spaceId": 0,
				"spaceRole": "",
				"status": 0,
				"updateTime": "",
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				},
				"userId": 0
			}
		],
		"spaceCover": "",
		"spaceDesc": "",
		"spaceLevel": 0,
		"spaceName": "",
		"spaceType": 0,
		"totalCount": 0,
		"totalSize": 0,
		"updateTime": "",
		"user": {
			"allowFollow": 0,
			"allowPrivateChat": 0,
			"createTime": "",
			"email": "",
			"fansCount": 0,
			"followCount": 0,
			"homepageBg": "",
			"id": 0,
			"showFansList": 0,
			"showFollowList": 0,
			"userAccount": "",
			"userAvatar": "",
			"userName": "",
			"userProfile": "",
			"userRole": ""
		},
		"userId": 0
	},
	"message": ""
}

listSpaceLevel

接口地址:/space/list/level

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«SpaceLevel»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	SpaceLevel
maxCount	integer(int64)
maxSize	integer(int64)
text	string
value	integer(int32)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"maxCount": 0,
			"maxSize": 0,
			"text": "",
			"value": 0
		}
	],
	"message": ""
}

listSpaceByPage

接口地址:/space/list/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "id": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "spaceLevel": 0,
  "spaceName": "",
  "spaceType": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceQueryRequest	spaceQueryRequest	body	true	SpaceQueryRequest	SpaceQueryRequest
current			false	integer(int32)
id			false	integer(int64)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
spaceLevel			false	integer(int32)
spaceName			false	string
spaceType			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«Space»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«Space»	Page«Space»
current	integer(int64)
pages	integer(int64)
records	array	Space
createTime	string
editTime	string
id	integer
isDelete	integer
isRecommended	integer
maxCount	integer
maxSize	integer
spaceCover	string
spaceDesc	string
spaceLevel	integer
spaceName	string
spaceType	integer
totalCount	integer
totalSize	integer
updateTime	string
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"createTime": "",
				"editTime": "",
				"id": 0,
				"isDelete": 0,
				"isRecommended": 0,
				"maxCount": 0,
				"maxSize": 0,
				"spaceCover": "",
				"spaceDesc": "",
				"spaceLevel": 0,
				"spaceName": "",
				"spaceType": 0,
				"totalCount": 0,
				"totalSize": 0,
				"updateTime": "",
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listSpaceVOByPage

接口地址:/space/list/page/vo

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "id": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "spaceLevel": 0,
  "spaceName": "",
  "spaceType": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceQueryRequest	spaceQueryRequest	body	true	SpaceQueryRequest	SpaceQueryRequest
current			false	integer(int32)
id			false	integer(int64)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
spaceLevel			false	integer(int32)
spaceName			false	string
spaceType			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«SpaceVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«SpaceVO»	Page«SpaceVO»
current	integer(int64)
pages	integer(int64)
records	array	SpaceVO
activities	array	Activity
activityExpired	boolean
commentCount	integer
content	string
coverUrl	string
createTime	string
expireTime	string
id	integer
isDelete	integer
isExpired	integer
isLiked	integer
isShared	integer
likeCount	integer
reviewMessage	string
shareCount	integer
spaceId	integer
status	integer
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
createTime	string
editTime	string
id	integer
isRecommended	integer
maxCount	integer
maxSize	integer
memberCount	integer
permissionList	array	string
recommendedUsers	array	SpaceUserVO
createTime	string
id	integer
space	SpaceVO	SpaceVO
spaceId	integer
spaceRole	string
status	integer
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
spaceCover	string
spaceDesc	string
spaceLevel	integer
spaceName	string
spaceType	integer
totalCount	integer
totalSize	integer
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"activities": [
					{
						"activityExpired": true,
						"commentCount": 0,
						"content": "",
						"coverUrl": "",
						"createTime": "",
						"expireTime": "",
						"id": 0,
						"isDelete": 0,
						"isExpired": 0,
						"isLiked": 0,
						"isShared": 0,
						"likeCount": 0,
						"reviewMessage": "",
						"shareCount": 0,
						"spaceId": 0,
						"status": 0,
						"title": "",
						"updateTime": "",
						"user": {
							"allowFollow": 0,
							"allowPrivateChat": 0,
							"createTime": "",
							"email": "",
							"fansCount": 0,
							"followCount": 0,
							"homepageBg": "",
							"id": 0,
							"showFansList": 0,
							"showFollowList": 0,
							"userAccount": "",
							"userAvatar": "",
							"userName": "",
							"userProfile": "",
							"userRole": ""
						},
						"userId": 0,
						"viewCount": 0
					}
				],
				"createTime": "",
				"editTime": "",
				"id": 0,
				"isRecommended": 0,
				"maxCount": 0,
				"maxSize": 0,
				"memberCount": 0,
				"permissionList": [],
				"recommendedUsers": [
					{
						"createTime": "",
						"id": 0,
						"space": {},
						"spaceId": 0,
						"spaceRole": "",
						"status": 0,
						"updateTime": "",
						"user": {
							"allowFollow": 0,
							"allowPrivateChat": 0,
							"createTime": "",
							"email": "",
							"fansCount": 0,
							"followCount": 0,
							"homepageBg": "",
							"id": 0,
							"showFansList": 0,
							"showFollowList": 0,
							"userAccount": "",
							"userAvatar": "",
							"userName": "",
							"userProfile": "",
							"userRole": ""
						},
						"userId": 0
					}
				],
				"spaceCover": "",
				"spaceDesc": "",
				"spaceLevel": 0,
				"spaceName": "",
				"spaceType": 0,
				"totalCount": 0,
				"totalSize": 0,
				"updateTime": "",
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				},
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

setRecommendStatus

接口地址:/space/recommend

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
recommendStatus	recommendStatus	query	true	integer(int32)
spaceId	spaceId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

listRecommendedSpaces

接口地址:/space/recommended

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«SpaceVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	SpaceVO
activities	array	Activity
activityExpired	boolean
commentCount	integer
content	string
coverUrl	string
createTime	string
expireTime	string
id	integer
isDelete	integer
isExpired	integer
isLiked	integer
isShared	integer
likeCount	integer
reviewMessage	string
shareCount	integer
spaceId	integer
status	integer
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
createTime	string(date-time)
editTime	string(date-time)
id	integer(int64)
isRecommended	integer(int32)
maxCount	integer(int64)
maxSize	integer(int64)
memberCount	integer(int64)
permissionList	array	string
recommendedUsers	array	SpaceUserVO
createTime	string
id	integer
space	SpaceVO	SpaceVO
spaceId	integer
spaceRole	string
status	integer
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
spaceCover	string
spaceDesc	string
spaceLevel	integer(int32)
spaceName	string
spaceType	integer(int32)
totalCount	integer(int64)
totalSize	integer(int64)
updateTime	string(date-time)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"activities": [
				{
					"activityExpired": true,
					"commentCount": 0,
					"content": "",
					"coverUrl": "",
					"createTime": "",
					"expireTime": "",
					"id": 0,
					"isDelete": 0,
					"isExpired": 0,
					"isLiked": 0,
					"isShared": 0,
					"likeCount": 0,
					"reviewMessage": "",
					"shareCount": 0,
					"spaceId": 0,
					"status": 0,
					"title": "",
					"updateTime": "",
					"user": {
						"allowFollow": 0,
						"allowPrivateChat": 0,
						"createTime": "",
						"email": "",
						"fansCount": 0,
						"followCount": 0,
						"homepageBg": "",
						"id": 0,
						"showFansList": 0,
						"showFollowList": 0,
						"userAccount": "",
						"userAvatar": "",
						"userName": "",
						"userProfile": "",
						"userRole": ""
					},
					"userId": 0,
					"viewCount": 0
				}
			],
			"createTime": "",
			"editTime": "",
			"id": 0,
			"isRecommended": 0,
			"maxCount": 0,
			"maxSize": 0,
			"memberCount": 0,
			"permissionList": [],
			"recommendedUsers": [
				{
					"createTime": "",
					"id": 0,
					"space": {},
					"spaceId": 0,
					"spaceRole": "",
					"status": 0,
					"updateTime": "",
					"user": {
						"allowFollow": 0,
						"allowPrivateChat": 0,
						"createTime": "",
						"email": "",
						"fansCount": 0,
						"followCount": 0,
						"homepageBg": "",
						"id": 0,
						"showFansList": 0,
						"showFollowList": 0,
						"userAccount": "",
						"userAvatar": "",
						"userName": "",
						"userProfile": "",
						"userRole": ""
					},
					"userId": 0
				}
			],
			"spaceCover": "",
			"spaceDesc": "",
			"spaceLevel": 0,
			"spaceName": "",
			"spaceType": 0,
			"totalCount": 0,
			"totalSize": 0,
			"updateTime": "",
			"user": {
				"allowFollow": 0,
				"allowPrivateChat": 0,
				"createTime": "",
				"email": "",
				"fansCount": 0,
				"followCount": 0,
				"homepageBg": "",
				"id": 0,
				"showFansList": 0,
				"showFollowList": 0,
				"userAccount": "",
				"userAvatar": "",
				"userName": "",
				"userProfile": "",
				"userRole": ""
			},
			"userId": 0
		}
	],
	"message": ""
}

updateSpace

接口地址:/space/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "id": 0,
  "maxCount": 0,
  "maxSize": 0,
  "spaceCover": "",
  "spaceDesc": "",
  "spaceLevel": 0,
  "spaceName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceUpdateRequest	spaceUpdateRequest	body	true	SpaceUpdateRequest	SpaceUpdateRequest
id			false	integer(int64)
maxCount			false	integer(int64)
maxSize			false	integer(int64)
spaceCover			false	string
spaceDesc			false	string
spaceLevel			false	integer(int32)
spaceName			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

space-user-controller

addSpaceUser

接口地址:/spaceUser/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "spaceId": 0,
  "spaceRole": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceUserAddRequest	spaceUserAddRequest	body	true	SpaceUserAddRequest	SpaceUserAddRequest
spaceId			false	integer(int64)
spaceRole			false	string
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

auditSpaceUser

接口地址:/spaceUser/audit

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "spaceId": 0,
  "status": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceUserAuditRequest	spaceUserAuditRequest	body	true	SpaceUserAuditRequest	SpaceUserAuditRequest
spaceId			false	integer(int64)
status			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

checkPendingApplication

接口地址:/spaceUser/checkPending

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "id": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "spaceId": 0,
  "spaceRole": "",
  "status": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryRequest	queryRequest	body	true	SpaceUserQueryRequest	SpaceUserQueryRequest
current			false	integer(int32)
id			false	integer(int64)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
spaceId			false	integer(int64)
spaceRole			false	string
status			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«SpaceUser»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	SpaceUser	SpaceUser
createTime	string(date-time)
id	integer(int64)
isRecommended	integer(int32)
spaceId	integer(int64)
spaceRole	string
status	integer(int32)
updateTime	string(date-time)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"createTime": "",
		"id": 0,
		"isRecommended": 0,
		"spaceId": 0,
		"spaceRole": "",
		"status": 0,
		"updateTime": "",
		"userId": 0
	},
	"message": ""
}

deleteSpaceUser

接口地址:/spaceUser/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "id": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deleteRequest	deleteRequest	body	true	DeleteRequest	DeleteRequest
id			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

editSpaceUser

接口地址:/spaceUser/edit

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "id": 0,
  "spaceRole": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceUserEditRequest	spaceUserEditRequest	body	true	SpaceUserEditRequest	SpaceUserEditRequest
id			false	integer(int64)
spaceRole			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getSpaceUser

接口地址:/spaceUser/get

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "id": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "spaceId": 0,
  "spaceRole": "",
  "status": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceUserQueryRequest	spaceUserQueryRequest	body	true	SpaceUserQueryRequest	SpaceUserQueryRequest
current			false	integer(int32)
id			false	integer(int64)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
spaceId			false	integer(int64)
spaceRole			false	string
status			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«SpaceUser»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	SpaceUser	SpaceUser
createTime	string(date-time)
id	integer(int64)
isRecommended	integer(int32)
spaceId	integer(int64)
spaceRole	string
status	integer(int32)
updateTime	string(date-time)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"createTime": "",
		"id": 0,
		"isRecommended": 0,
		"spaceId": 0,
		"spaceRole": "",
		"status": 0,
		"updateTime": "",
		"userId": 0
	},
	"message": ""
}

joinSpace

接口地址:/spaceUser/join

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "spaceId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceUserJoinRequest	spaceUserJoinRequest	body	true	SpaceUserJoinRequest	SpaceUserJoinRequest
spaceId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

listSpaceUser

接口地址:/spaceUser/list

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "id": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "spaceId": 0,
  "spaceRole": "",
  "status": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
spaceUserQueryRequest	spaceUserQueryRequest	body	true	SpaceUserQueryRequest	SpaceUserQueryRequest
current			false	integer(int32)
id			false	integer(int64)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
spaceId			false	integer(int64)
spaceRole			false	string
status			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«SpaceUserVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	SpaceUserVO
createTime	string(date-time)
id	integer(int64)
space	SpaceVO	SpaceVO
activities	array	Activity
activityExpired	boolean
commentCount	integer
content	string
coverUrl	string
createTime	string
expireTime	string
id	integer
isDelete	integer
isExpired	integer
isLiked	integer
isShared	integer
likeCount	integer
reviewMessage	string
shareCount	integer
spaceId	integer
status	integer
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
createTime	string
editTime	string
id	integer
isRecommended	integer
maxCount	integer
maxSize	integer
memberCount	integer
permissionList	array	string
recommendedUsers	array	SpaceUserVO
spaceCover	string
spaceDesc	string
spaceLevel	integer
spaceName	string
spaceType	integer
totalCount	integer
totalSize	integer
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
spaceId	integer(int64)
spaceRole	string
status	integer(int32)
updateTime	string(date-time)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"createTime": "",
			"id": 0,
			"space": {},
			"spaceId": 0,
			"spaceRole": "",
			"status": 0,
			"updateTime": "",
			"user": {
				"allowFollow": 0,
				"allowPrivateChat": 0,
				"createTime": "",
				"email": "",
				"fansCount": 0,
				"followCount": 0,
				"homepageBg": "",
				"id": 0,
				"showFansList": 0,
				"showFollowList": 0,
				"userAccount": "",
				"userAvatar": "",
				"userName": "",
				"userProfile": "",
				"userRole": ""
			},
			"userId": 0
		}
	],
	"message": ""
}

listMyTeamSpace

接口地址:/spaceUser/list/my

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«SpaceVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	SpaceVO
activities	array	Activity
activityExpired	boolean
commentCount	integer
content	string
coverUrl	string
createTime	string
expireTime	string
id	integer
isDelete	integer
isExpired	integer
isLiked	integer
isShared	integer
likeCount	integer
reviewMessage	string
shareCount	integer
spaceId	integer
status	integer
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
createTime	string(date-time)
editTime	string(date-time)
id	integer(int64)
isRecommended	integer(int32)
maxCount	integer(int64)
maxSize	integer(int64)
memberCount	integer(int64)
permissionList	array	string
recommendedUsers	array	SpaceUserVO
createTime	string
id	integer
space	SpaceVO	SpaceVO
spaceId	integer
spaceRole	string
status	integer
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
spaceCover	string
spaceDesc	string
spaceLevel	integer(int32)
spaceName	string
spaceType	integer(int32)
totalCount	integer(int64)
totalSize	integer(int64)
updateTime	string(date-time)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"activities": [
				{
					"activityExpired": true,
					"commentCount": 0,
					"content": "",
					"coverUrl": "",
					"createTime": "",
					"expireTime": "",
					"id": 0,
					"isDelete": 0,
					"isExpired": 0,
					"isLiked": 0,
					"isShared": 0,
					"likeCount": 0,
					"reviewMessage": "",
					"shareCount": 0,
					"spaceId": 0,
					"status": 0,
					"title": "",
					"updateTime": "",
					"user": {
						"allowFollow": 0,
						"allowPrivateChat": 0,
						"createTime": "",
						"email": "",
						"fansCount": 0,
						"followCount": 0,
						"homepageBg": "",
						"id": 0,
						"showFansList": 0,
						"showFollowList": 0,
						"userAccount": "",
						"userAvatar": "",
						"userName": "",
						"userProfile": "",
						"userRole": ""
					},
					"userId": 0,
					"viewCount": 0
				}
			],
			"createTime": "",
			"editTime": "",
			"id": 0,
			"isRecommended": 0,
			"maxCount": 0,
			"maxSize": 0,
			"memberCount": 0,
			"permissionList": [],
			"recommendedUsers": [
				{
					"createTime": "",
					"id": 0,
					"space": {},
					"spaceId": 0,
					"spaceRole": "",
					"status": 0,
					"updateTime": "",
					"user": {
						"allowFollow": 0,
						"allowPrivateChat": 0,
						"createTime": "",
						"email": "",
						"fansCount": 0,
						"followCount": 0,
						"homepageBg": "",
						"id": 0,
						"showFansList": 0,
						"showFollowList": 0,
						"userAccount": "",
						"userAvatar": "",
						"userName": "",
						"userProfile": "",
						"userRole": ""
					},
					"userId": 0
				}
			],
			"spaceCover": "",
			"spaceDesc": "",
			"spaceLevel": 0,
			"spaceName": "",
			"spaceType": 0,
			"totalCount": 0,
			"totalSize": 0,
			"updateTime": "",
			"user": {
				"allowFollow": 0,
				"allowPrivateChat": 0,
				"createTime": "",
				"email": "",
				"fansCount": 0,
				"followCount": 0,
				"homepageBg": "",
				"id": 0,
				"showFansList": 0,
				"showFollowList": 0,
				"userAccount": "",
				"userAvatar": "",
				"userName": "",
				"userProfile": "",
				"userRole": ""
			},
			"userId": 0
		}
	],
	"message": ""
}

listRecommendedMembers

接口地址:/spaceUser/list/recommended

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "id": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "spaceId": 0,
  "spaceRole": "",
  "status": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryRequest	queryRequest	body	true	SpaceUserQueryRequest	SpaceUserQueryRequest
current			false	integer(int32)
id			false	integer(int64)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
spaceId			false	integer(int64)
spaceRole			false	string
status			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«SpaceUserVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	SpaceUserVO
createTime	string(date-time)
id	integer(int64)
space	SpaceVO	SpaceVO
activities	array	Activity
activityExpired	boolean
commentCount	integer
content	string
coverUrl	string
createTime	string
expireTime	string
id	integer
isDelete	integer
isExpired	integer
isLiked	integer
isShared	integer
likeCount	integer
reviewMessage	string
shareCount	integer
spaceId	integer
status	integer
title	string
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
createTime	string
editTime	string
id	integer
isRecommended	integer
maxCount	integer
maxSize	integer
memberCount	integer
permissionList	array	string
recommendedUsers	array	SpaceUserVO
spaceCover	string
spaceDesc	string
spaceLevel	integer
spaceName	string
spaceType	integer
totalCount	integer
totalSize	integer
updateTime	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
spaceId	integer(int64)
spaceRole	string
status	integer(int32)
updateTime	string(date-time)
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"createTime": "",
			"id": 0,
			"space": {},
			"spaceId": 0,
			"spaceRole": "",
			"status": 0,
			"updateTime": "",
			"user": {
				"allowFollow": 0,
				"allowPrivateChat": 0,
				"createTime": "",
				"email": "",
				"fansCount": 0,
				"followCount": 0,
				"homepageBg": "",
				"id": 0,
				"showFansList": 0,
				"showFollowList": 0,
				"userAccount": "",
				"userAvatar": "",
				"userName": "",
				"userProfile": "",
				"userRole": ""
			},
			"userId": 0
		}
	],
	"message": ""
}

quitSpace

接口地址:/spaceUser/quit

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "id": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deleteRequest	deleteRequest	body	true	DeleteRequest	DeleteRequest
id			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

setRecommendedMember

接口地址:/spaceUser/setRecommended

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "isRecommended": 0,
  "spaceId": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
recommendRequest	recommendRequest	body	true	SpaceUserRecommendRequest	SpaceUserRecommendRequest
isRecommended			false	integer(int32)
spaceId			false	integer(int64)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

system-notify-controller

listSystemNotifies

接口地址:/notifies

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	请求类型	是否必须	数据类型
current	query	false	integer(int32)
isEnabled	query	false	integer(int32)
notifyType	query	false	string
pageSize	query	false	integer(int32)
readStatus	query	false	integer(int32)
receiverType	query	false	string
sortField	query	false	string
sortOrder	query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«SystemNotify»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«SystemNotify»	Page«SystemNotify»
current	integer(int64)
pages	integer(int64)
records	array	SystemNotify
content	string
createTime	string
expireTime	string
id	integer
isDelete	integer
isEnabled	integer
isGlobal	integer
notifyIcon	string
notifyType	string
operatorId	string
operatorType	string
readStatus	integer
readTime	string
receiverId	string
receiverType	string
relatedBizId	string
relatedBizType	string
senderId	string
senderType	string
title	string
updateTime	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"content": "",
				"createTime": "",
				"expireTime": "",
				"id": 0,
				"isDelete": 0,
				"isEnabled": 0,
				"isGlobal": 0,
				"notifyIcon": "",
				"notifyType": "",
				"operatorId": "",
				"operatorType": "",
				"readStatus": 0,
				"readTime": "",
				"receiverId": "",
				"receiverType": "",
				"relatedBizId": "",
				"relatedBizType": "",
				"senderId": "",
				"senderType": "",
				"title": "",
				"updateTime": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

addSystemNotify

接口地址:/notifies

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "content": "",
  "expireTime": "",
  "isEnabled": 0,
  "isGlobal": 0,
  "notifyIcon": "",
  "notifyType": "",
  "receiverId": "",
  "receiverType": "",
  "relatedBizId": "",
  "relatedBizType": "",
  "senderId": "",
  "senderType": "",
  "title": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
systemNotifyAddRequest	systemNotifyAddRequest	body	true	SystemNotifyAddRequest	SystemNotifyAddRequest
content			false	string
expireTime			false	string(date-time)
isEnabled			false	integer(int32)
isGlobal			false	integer(int32)
notifyIcon			false	string
notifyType			false	string
receiverId			false	string
receiverType			false	string
relatedBizId			false	string
relatedBizType			false	string
senderId			false	string
senderType			false	string
title			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

listUserNotifies

接口地址:/notifies/user/notifies

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	请求类型	是否必须	数据类型
current	query	false	integer(int32)
isEnabled	query	false	integer(int32)
notifyType	query	false	string
pageSize	query	false	integer(int32)
readStatus	query	false	integer(int32)
receiverType	query	false	string
sortField	query	false	string
sortOrder	query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«SystemNotify»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«SystemNotify»	Page«SystemNotify»
current	integer(int64)
pages	integer(int64)
records	array	SystemNotify
content	string
createTime	string
expireTime	string
id	integer
isDelete	integer
isEnabled	integer
isGlobal	integer
notifyIcon	string
notifyType	string
operatorId	string
operatorType	string
readStatus	integer
readTime	string
receiverId	string
receiverType	string
relatedBizId	string
relatedBizType	string
senderId	string
senderType	string
title	string
updateTime	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"content": "",
				"createTime": "",
				"expireTime": "",
				"id": 0,
				"isDelete": 0,
				"isEnabled": 0,
				"isGlobal": 0,
				"notifyIcon": "",
				"notifyType": "",
				"operatorId": "",
				"operatorType": "",
				"readStatus": 0,
				"readTime": "",
				"receiverId": "",
				"receiverType": "",
				"relatedBizId": "",
				"relatedBizType": "",
				"senderId": "",
				"senderType": "",
				"title": "",
				"updateTime": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

listUserReadNotifies

接口地址:/notifies/user/notifies/read-history

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	请求类型	是否必须	数据类型
current	query	false	integer(int32)
isEnabled	query	false	integer(int32)
notifyType	query	false	string
pageSize	query	false	integer(int32)
readStatus	query	false	integer(int32)
receiverType	query	false	string
sortField	query	false	string
sortOrder	query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«SystemNotify»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«SystemNotify»	Page«SystemNotify»
current	integer(int64)
pages	integer(int64)
records	array	SystemNotify
content	string
createTime	string
expireTime	string
id	integer
isDelete	integer
isEnabled	integer
isGlobal	integer
notifyIcon	string
notifyType	string
operatorId	string
operatorType	string
readStatus	integer
readTime	string
receiverId	string
receiverType	string
relatedBizId	string
relatedBizType	string
senderId	string
senderType	string
title	string
updateTime	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"content": "",
				"createTime": "",
				"expireTime": "",
				"id": 0,
				"isDelete": 0,
				"isEnabled": 0,
				"isGlobal": 0,
				"notifyIcon": "",
				"notifyType": "",
				"operatorId": "",
				"operatorType": "",
				"readStatus": 0,
				"readTime": "",
				"receiverId": "",
				"receiverType": "",
				"relatedBizId": "",
				"relatedBizType": "",
				"senderId": "",
				"senderType": "",
				"title": "",
				"updateTime": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

getUserUnreadCount

接口地址:/notifies/user/notifies/unread-count

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

getUserNotifyById

接口地址:/notifies/user/notifies/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«SystemNotify»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	SystemNotify	SystemNotify
content	string
createTime	string(date-time)
expireTime	string(date-time)
id	integer(int64)
isDelete	integer(int32)
isEnabled	integer(int32)
isGlobal	integer(int32)
notifyIcon	string
notifyType	string
operatorId	string
operatorType	string
readStatus	integer(int32)
readTime	string(date-time)
receiverId	string
receiverType	string
relatedBizId	string
relatedBizType	string
senderId	string
senderType	string
title	string
updateTime	string(date-time)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"content": "",
		"createTime": "",
		"expireTime": "",
		"id": 0,
		"isDelete": 0,
		"isEnabled": 0,
		"isGlobal": 0,
		"notifyIcon": "",
		"notifyType": "",
		"operatorId": "",
		"operatorType": "",
		"readStatus": 0,
		"readTime": "",
		"receiverId": "",
		"receiverType": "",
		"relatedBizId": "",
		"relatedBizType": "",
		"senderId": "",
		"senderType": "",
		"title": "",
		"updateTime": ""
	},
	"message": ""
}

markAsRead

接口地址:/notifies/user/notifies/{id}/read

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getSystemNotifyById

接口地址:/notifies/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«SystemNotify»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	SystemNotify	SystemNotify
content	string
createTime	string(date-time)
expireTime	string(date-time)
id	integer(int64)
isDelete	integer(int32)
isEnabled	integer(int32)
isGlobal	integer(int32)
notifyIcon	string
notifyType	string
operatorId	string
operatorType	string
readStatus	integer(int32)
readTime	string(date-time)
receiverId	string
receiverType	string
relatedBizId	string
relatedBizType	string
senderId	string
senderType	string
title	string
updateTime	string(date-time)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"content": "",
		"createTime": "",
		"expireTime": "",
		"id": 0,
		"isDelete": 0,
		"isEnabled": 0,
		"isGlobal": 0,
		"notifyIcon": "",
		"notifyType": "",
		"operatorId": "",
		"operatorType": "",
		"readStatus": 0,
		"readTime": "",
		"receiverId": "",
		"receiverType": "",
		"relatedBizId": "",
		"relatedBizType": "",
		"senderId": "",
		"senderType": "",
		"title": "",
		"updateTime": ""
	},
	"message": ""
}

updateSystemNotify

接口地址:/notifies/{id}

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "content": "",
  "id": 0,
  "isEnabled": 0,
  "title": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)
systemNotifyUpdateRequest	systemNotifyUpdateRequest	body	true	SystemNotifyUpdateRequest	SystemNotifyUpdateRequest
content			false	string
id			false	integer(int64)
isEnabled			false	integer(int32)
title			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«SystemNotify»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	SystemNotify	SystemNotify
content	string
createTime	string(date-time)
expireTime	string(date-time)
id	integer(int64)
isDelete	integer(int32)
isEnabled	integer(int32)
isGlobal	integer(int32)
notifyIcon	string
notifyType	string
operatorId	string
operatorType	string
readStatus	integer(int32)
readTime	string(date-time)
receiverId	string
receiverType	string
relatedBizId	string
relatedBizType	string
senderId	string
senderType	string
title	string
updateTime	string(date-time)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"content": "",
		"createTime": "",
		"expireTime": "",
		"id": 0,
		"isDelete": 0,
		"isEnabled": 0,
		"isGlobal": 0,
		"notifyIcon": "",
		"notifyType": "",
		"operatorId": "",
		"operatorType": "",
		"readStatus": 0,
		"readTime": "",
		"receiverId": "",
		"receiverType": "",
		"relatedBizId": "",
		"relatedBizType": "",
		"senderId": "",
		"senderType": "",
		"title": "",
		"updateTime": ""
	},
	"message": ""
}

deleteSystemNotify

接口地址:/notifies/{id}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
204	No Content
401	Unauthorized
403	Forbidden

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

tag-controller

addTag

接口地址:/tag/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
tagName	tagName	query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

deleteTag

接口地址:/tag/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

listTagVOByPage

接口地址:/tag/list/page/vo

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pageRequest	pageRequest	body	true	PageRequest	PageRequest
current			false	integer(int32)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«TagVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«TagVO»	Page«TagVO»
current	integer(int64)
pages	integer(int64)
records	array	TagVO
createTime	string
editTime	string
id	integer
tagName	string
updateTime	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"createTime": "",
				"editTime": "",
				"id": 0,
				"tagName": "",
				"updateTime": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

searchTag

接口地址:/tag/search

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
tagName	tagName	query	false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«TagVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	TagVO
createTime	string(date-time)
editTime	string(date-time)
id	integer(int64)
tagName	string
updateTime	string(date-time)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"createTime": "",
			"editTime": "",
			"id": 0,
			"tagName": "",
			"updateTime": ""
		}
	],
	"message": ""
}

time-album-controller

addTimeAlbum

接口地址:/timeAlbum/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "albumName": "",
  "coverUrl": "",
  "createTime": "",
  "description": "",
  "id": 0,
  "isDelete": 0,
  "isPublic": 0,
  "loveBoardId": 0,
  "password": "",
  "updateTime": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
loveBoardId	loveBoardId	query	true	integer(int64)
timeAlbum	timeAlbum	body	true	TimeAlbum	TimeAlbum
albumName			false	string
coverUrl			false	string
createTime			false	string(date-time)
description			false	string
id			false	integer(int64)
isDelete			false	integer(int32)
isPublic			false	integer(int32)
loveBoardId			false	integer(int64)
password			false	string
updateTime			false	string(date-time)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

deleteTimeAlbum

接口地址:/timeAlbum/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	true	integer(int64)
loveBoardId	loveBoardId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getTimeAlbumById

接口地址:/timeAlbum/get

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	id	query	true	integer(int64)
password	password	query	false	string
userId	userId	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«TimeAlbum»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	TimeAlbum	TimeAlbum
albumName	string
coverUrl	string
createTime	string(date-time)
description	string
id	integer(int64)
isDelete	integer(int32)
isPublic	integer(int32)
loveBoardId	integer(int64)
password	string
updateTime	string(date-time)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"albumName": "",
		"coverUrl": "",
		"createTime": "",
		"description": "",
		"id": 0,
		"isDelete": 0,
		"isPublic": 0,
		"loveBoardId": 0,
		"password": "",
		"updateTime": "",
		"userId": 0
	},
	"message": ""
}

deleteHeartWallPicture

接口地址:/timeAlbum/heart-wall/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
albumId	albumId	query	true	integer(int64)
pictureId	pictureId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getHeartWallPictures

接口地址:/timeAlbum/heart-wall/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
albumId	albumId	query	true	integer(int64)
password	password	query	false	string
userId	userId	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«Picture»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	Picture
allowCollect	integer(int32)
allowComment	integer(int32)
allowLike	integer(int32)
allowShare	integer(int32)
category	string
commentCount	integer(int64)
createTime	string(date-time)
editTime	string(date-time)
favoriteCount	integer(int64)
hotScore	number(double)
id	integer(int64)
introduction	string
isDelete	integer(int32)
isDownload	integer(int32)
isDraft	integer(int32)
isFeature	integer(int32)
likeCount	integer(int64)
name	string
picColor	string
picFormat	string
picHeight	integer(int32)
picScale	number(double)
picSize	integer(int64)
picWidth	integer(int32)
recommendScore	number(double)
reviewMessage	string
reviewStatus	integer(int32)
reviewTime	string(date-time)
reviewerId	integer(int64)
shareCount	integer(int64)
spaceId	integer(int64)
tags	string
thumbnailUrl	string
updateTime	string(date-time)
url	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"allowCollect": 0,
			"allowComment": 0,
			"allowLike": 0,
			"allowShare": 0,
			"category": "",
			"commentCount": 0,
			"createTime": "",
			"editTime": "",
			"favoriteCount": 0,
			"hotScore": 0,
			"id": 0,
			"introduction": "",
			"isDelete": 0,
			"isDownload": 0,
			"isDraft": 0,
			"isFeature": 0,
			"likeCount": 0,
			"name": "",
			"picColor": "",
			"picFormat": "",
			"picHeight": 0,
			"picScale": 0,
			"picSize": 0,
			"picWidth": 0,
			"recommendScore": 0,
			"reviewMessage": "",
			"reviewStatus": 0,
			"reviewTime": "",
			"reviewerId": 0,
			"shareCount": 0,
			"spaceId": 0,
			"tags": "",
			"thumbnailUrl": "",
			"updateTime": "",
			"url": "",
			"userId": 0,
			"viewCount": 0
		}
	],
	"message": ""
}

uploadHeartWallPictures

接口地址:/timeAlbum/heart-wall/upload

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	请求类型	是否必须	数据类型	schema
albumId	query	false	integer(int64)
files	query	false	array	file
override	query	false	boolean

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«PictureVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer(int64)
commentCount	integer(int64)
createTime	string(date-time)
editTime	string(date-time)
favoriteCount	integer(int64)
id	integer(int64)
introduction	string
isDownload	integer(int32)
isFavorited	integer(int32)
isFeature	integer(int32)
isLiked	integer(int32)
isShared	integer(int32)
likeCount	integer(int64)
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer(int32)
picScale	number(double)
picSize	integer(int64)
picWidth	integer(int32)
recommendScore	number(double)
reviewMessage	string
reviewStatus	integer(int32)
shareCount	integer(int64)
spaceId	integer(int64)
tags	array	string
thumbnailUrl	string
updateTime	string(date-time)
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer(int64)
viewCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [
		{
			"allowCollect": true,
			"allowComment": true,
			"allowLike": true,
			"allowShare": true,
			"category": "",
			"chatCount": 0,
			"commentCount": 0,
			"createTime": "",
			"editTime": "",
			"favoriteCount": 0,
			"id": 0,
			"introduction": "",
			"isDownload": 0,
			"isFavorited": 0,
			"isFeature": 0,
			"isLiked": 0,
			"isShared": 0,
			"likeCount": 0,
			"name": "",
			"permissionList": [],
			"picColor": "",
			"picFormat": "",
			"picHeight": 0,
			"picScale": 0,
			"picSize": 0,
			"picWidth": 0,
			"recommendScore": 0,
			"reviewMessage": "",
			"reviewStatus": 0,
			"shareCount": 0,
			"spaceId": 0,
			"tags": [],
			"thumbnailUrl": "",
			"updateTime": "",
			"url": "",
			"user": {
				"allowFollow": 0,
				"allowPrivateChat": 0,
				"createTime": "",
				"email": "",
				"fansCount": 0,
				"followCount": 0,
				"homepageBg": "",
				"id": 0,
				"showFansList": 0,
				"showFollowList": 0,
				"userAccount": "",
				"userAvatar": "",
				"userName": "",
				"userProfile": "",
				"userRole": ""
			},
			"userId": 0,
			"viewCount": 0
		}
	],
	"message": ""
}

listTimeAlbum

接口地址:/timeAlbum/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
current	current	query	true	integer(int64)
loveBoardId	loveBoardId	query	true	integer(int64)
pageSize	pageSize	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«TimeAlbum»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«TimeAlbum»	Page«TimeAlbum»
current	integer(int64)
pages	integer(int64)
records	array	TimeAlbum
albumName	string
coverUrl	string
createTime	string
description	string
id	integer
isDelete	integer
isPublic	integer
loveBoardId	integer
password	string
updateTime	string
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"albumName": "",
				"coverUrl": "",
				"createTime": "",
				"description": "",
				"id": 0,
				"isDelete": 0,
				"isPublic": 0,
				"loveBoardId": 0,
				"password": "",
				"updateTime": "",
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

removeAlbumPassword

接口地址:/timeAlbum/password/remove

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "albumId": 0,
  "newPassword": "",
  "oldPassword": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
request	request	body	true	TimeAlbumPasswordRequest	TimeAlbumPasswordRequest
albumId			false	integer(int64)
newPassword			false	string
oldPassword			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

setAlbumPassword

接口地址:/timeAlbum/password/set

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "albumId": 0,
  "newPassword": "",
  "oldPassword": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
request	request	body	true	TimeAlbumPasswordRequest	TimeAlbumPasswordRequest
albumId			false	integer(int64)
newPassword			false	string
oldPassword			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

updateAlbumPassword

接口地址:/timeAlbum/password/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "albumId": 0,
  "newPassword": "",
  "oldPassword": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
request	request	body	true	TimeAlbumPasswordRequest	TimeAlbumPasswordRequest
albumId			false	integer(int64)
newPassword			false	string
oldPassword			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

updateTimeAlbum

接口地址:/timeAlbum/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "albumName": "",
  "coverUrl": "",
  "createTime": "",
  "description": "",
  "id": 0,
  "isDelete": 0,
  "isPublic": 0,
  "loveBoardId": 0,
  "password": "",
  "updateTime": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
loveBoardId	loveBoardId	query	true	integer(int64)
timeAlbum	timeAlbum	body	true	TimeAlbum	TimeAlbum
albumName			false	string
coverUrl			false	string
createTime			false	string(date-time)
description			false	string
id			false	integer(int64)
isDelete			false	integer(int32)
isPublic			false	integer(int32)
loveBoardId			false	integer(int64)
password			false	string
updateTime			false	string(date-time)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

user-controller

addUser

接口地址:/user/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "birthday": "",
  "gender": "",
  "homepageBg": "",
  "interestField": "",
  "lastActiveTime": "",
  "personalSign": "",
  "region": "",
  "themePreference": "",
  "userAccount": "",
  "userAvatar": "",
  "userName": "",
  "userProfile": "",
  "userRole": "",
  "userTags": "",
  "visibilitySetting": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userAddRequest	userAddRequest	body	true	UserAddRequest	UserAddRequest
birthday			false	string(date-time)
gender			false	string
homepageBg			false	string
interestField			false	string
lastActiveTime			false	string(date-time)
personalSign			false	string
region			false	string
themePreference			false	string
userAccount			false	string
userAvatar			false	string
userName			false	string
userProfile			false	string
userRole			false	string
userTags			false	string
visibilitySetting			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

addUserSignIn

接口地址:/user/add/sign_in

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

banOrUnbanUser

接口地址:/user/ban

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "isUnban": true,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
request	request	body	true	UserUnbanRequest	UserUnbanRequest
isUnban			false	boolean
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

batchDeleteUser

接口地址:/user/batchDelete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

[]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deleteRequestList	deleteRequestList	body	true	array	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

changeEmail

接口地址:/user/change/email

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "code": "",
  "newEmail": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userChangeEmailRequest	userChangeEmailRequest	body	true	UserChangeEmailRequest	UserChangeEmailRequest
code			false	string
newEmail			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

changePassword

接口地址:/user/changePassword

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "checkPassword": "",
  "id": 0,
  "newPassword": "",
  "oldPassword": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userModifyPassWord	userModifyPassWord	body	true	UserModifyPassWord	UserModifyPassWord
checkPassword			false	string
id			false	integer(int64)
newPassword			false	string
oldPassword			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

deleteUser

接口地址:/user/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "id": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deleteRequest	deleteRequest	body	true	DeleteRequest	DeleteRequest
id			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

deleteBatchUser

接口地址:/user/delete/batch

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

[
  {
    "id": 0
  }
]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deleteRequestList	deleteRequestList	body	true	array	DeleteRequest
id			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

userDestroy

接口地址:/user/destroy

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "id": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userDestroyRequest	userDestroyRequest	body	true	DeleteRequest	DeleteRequest
id			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

userDestroySecure

接口地址:/user/destroy_secure

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "code": "",
  "userPassword": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userDestroySecureRequest	userDestroySecureRequest	body	true	UserDestroySecureRequest	UserDestroySecureRequest
code			false	string
userPassword			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

exportUsers

接口地址:/user/export

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "endTime": "",
  "startTime": "",
  "type": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
exportRequest	exportRequest	body	true	UserExportRequest	UserExportRequest
endTime			false	string(date-time)
startTime			false	string(date-time)
type			false	integer(int32)

响应状态:

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

响应参数:

暂无

响应示例:

javascript

getUserById

接口地址:/user/get

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«User»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	User	User
allowFollow	integer(int32)
allowMultiDeviceLogin	integer(int32)
allowPrivateChat	integer(int32)
birthday	string(date-time)
createTime	string(date-time)
editTime	string(date-time)
email	string
gender	string
homepageBg	string
id	integer(int64)
interestField	string
isDelete	integer(int32)
lastActiveTime	string(date-time)
personalSign	string
region	string
showFansList	integer(int32)
showFollowList	integer(int32)
themePreference	string
updateTime	string(date-time)
userAccount	string
userAvatar	string
userName	string
userPassword	string
userProfile	string
userRole	string
userTags	string
visibilitySetting	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"allowFollow": 0,
		"allowMultiDeviceLogin": 0,
		"allowPrivateChat": 0,
		"birthday": "",
		"createTime": "",
		"editTime": "",
		"email": "",
		"gender": "",
		"homepageBg": "",
		"id": 0,
		"interestField": "",
		"isDelete": 0,
		"lastActiveTime": "",
		"personalSign": "",
		"region": "",
		"showFansList": 0,
		"showFollowList": 0,
		"themePreference": "",
		"updateTime": "",
		"userAccount": "",
		"userAvatar": "",
		"userName": "",
		"userPassword": "",
		"userProfile": "",
		"userRole": "",
		"userTags": "",
		"visibilitySetting": ""
	},
	"message": ""
}

getLoginUser

接口地址:/user/get/login

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«LoginUserVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	LoginUserVO	LoginUserVO
birthday	string(date-time)
createTime	string(date-time)
editTime	string(date-time)
email	string
gender	string
homepageBg	string
id	integer(int64)
personalSign	string
region	string
updateTime	string(date-time)
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userTags	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"birthday": "",
		"createTime": "",
		"editTime": "",
		"email": "",
		"gender": "",
		"homepageBg": "",
		"id": 0,
		"personalSign": "",
		"region": "",
		"updateTime": "",
		"userAccount": "",
		"userAvatar": "",
		"userName": "",
		"userProfile": "",
		"userRole": "",
		"userTags": ""
	},
	"message": ""
}

getUserMultiDeviceLogin

接口地址:/user/get/multi_device_login

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId	userId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«int»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int32)	integer(int32)
message	string

响应示例:

javascript

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

getUserPermissions

接口地址:/user/get/permissions

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId	userId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«UserUpdatePermissionsRequest»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	UserUpdatePermissionsRequest	UserUpdatePermissionsRequest
allowFollow	integer(int32)
allowPrivateChat	integer(int32)
showFansList	integer(int32)
showFollowList	integer(int32)
userId	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"allowFollow": 0,
		"allowPrivateChat": 0,
		"showFansList": 0,
		"showFollowList": 0,
		"userId": 0
	},
	"message": ""
}

getUserPublicInfo

接口地址:/user/get/public

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId	userId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«UserPublicVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	UserPublicVO	UserPublicVO
allowFollow	integer(int32)
allowPrivateChat	integer(int32)
birthday	string
createTime	string(date-time)
gender	string
homepageBg	string
id	integer(int64)
personalSign	string
region	string
showFansList	integer(int32)
showFollowList	integer(int32)
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userTags	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"allowFollow": 0,
		"allowPrivateChat": 0,
		"birthday": "",
		"createTime": "",
		"gender": "",
		"homepageBg": "",
		"id": 0,
		"personalSign": "",
		"region": "",
		"showFansList": 0,
		"showFollowList": 0,
		"userAccount": "",
		"userAvatar": "",
		"userName": "",
		"userProfile": "",
		"userRole": "",
		"userTags": ""
	},
	"message": ""
}

getUserSignInRecord

接口地址:/user/get/sign_in

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
year	year	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«List«int»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	array	integer(int32)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": [],
	"message": ""
}

getUserVOById

接口地址:/user/get/vo

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«UserVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	UserVO	UserVO
allowFollow	integer(int32)
allowPrivateChat	integer(int32)
createTime	string(date-time)
email	string
fansCount	integer(int64)
followCount	integer(int64)
homepageBg	string
id	integer(int64)
showFansList	integer(int32)
showFollowList	integer(int32)
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"allowFollow": 0,
		"allowPrivateChat": 0,
		"createTime": "",
		"email": "",
		"fansCount": 0,
		"followCount": 0,
		"homepageBg": "",
		"id": 0,
		"showFansList": 0,
		"showFollowList": 0,
		"userAccount": "",
		"userAvatar": "",
		"userName": "",
		"userProfile": "",
		"userRole": ""
	},
	"message": ""
}

getDestroyCode

接口地址:/user/get_destroy_code

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

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

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	string
message	string

响应示例:

javascript

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

getEmailCode

接口地址:/user/get_emailcode

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "email": "",
  "type": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
emailCodeRequest	emailCodeRequest	body	true	EmailCodeRequest	EmailCodeRequest
email			false	string
type			false	string

响应状态:

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

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	string
message	string

响应示例:

javascript

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

getCode

接口地址:/user/getcode

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Map«string,string»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	object
message	string

响应示例:

javascript

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

listUserVOByPage

接口地址:/user/list/page/vo

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "gender": "",
  "homepageBg": "",
  "id": 0,
  "interestField": "",
  "pageSize": 0,
  "personalSign": "",
  "region": "",
  "sortField": "",
  "sortOrder": "",
  "themePreference": "",
  "userAccount": "",
  "userName": "",
  "userProfile": "",
  "userRole": "",
  "userTags": "",
  "visibilitySetting": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userQueryRequest	userQueryRequest	body	true	UserQueryRequest	UserQueryRequest
current			false	integer(int32)
gender			false	string
homepageBg			false	string
id			false	integer(int64)
interestField			false	string
pageSize			false	integer(int32)
personalSign			false	string
region			false	string
sortField			false	string
sortOrder			false	string
themePreference			false	string
userAccount			false	string
userName			false	string
userProfile			false	string
userRole			false	string
userTags			false	string
visibilitySetting			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«UserVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«UserVO»	Page«UserVO»
current	integer(int64)
pages	integer(int64)
records	array	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"allowFollow": 0,
				"allowPrivateChat": 0,
				"createTime": "",
				"email": "",
				"fansCount": 0,
				"followCount": 0,
				"homepageBg": "",
				"id": 0,
				"showFansList": 0,
				"showFollowList": 0,
				"userAccount": "",
				"userAvatar": "",
				"userName": "",
				"userProfile": "",
				"userRole": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

userLogin

接口地址:/user/login

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "accountOrEmail": "",
  "serververifycode": "",
  "userPassword": "",
  "verifyCode": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userLoginRequest	userLoginRequest	body	true	UserLoginRequest	UserLoginRequest
accountOrEmail			false	string
serververifycode			false	string
userPassword			false	string
verifyCode			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«LoginUserVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	LoginUserVO	LoginUserVO
birthday	string(date-time)
createTime	string(date-time)
editTime	string(date-time)
email	string
gender	string
homepageBg	string
id	integer(int64)
personalSign	string
region	string
updateTime	string(date-time)
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userTags	string
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"birthday": "",
		"createTime": "",
		"editTime": "",
		"email": "",
		"gender": "",
		"homepageBg": "",
		"id": 0,
		"personalSign": "",
		"region": "",
		"updateTime": "",
		"userAccount": "",
		"userAvatar": "",
		"userName": "",
		"userProfile": "",
		"userRole": "",
		"userTags": ""
	},
	"message": ""
}

userLogout

接口地址:/user/logout

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

userRegister

接口地址:/user/register

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "checkPassword": "",
  "code": "",
  "email": "",
  "userPassword": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userRegisterRequest	userRegisterRequest	body	true	UserRegisterRequest	UserRegisterRequest
checkPassword			false	string
code			false	string
email			false	string
userPassword			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

resetPassword

接口地址:/user/reset/password

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "checkPassword": "",
  "code": "",
  "email": "",
  "newPassword": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
resetPasswordRequest	resetPasswordRequest	body	true	UserResetPasswordRequest	UserResetPasswordRequest
checkPassword			false	string
code			false	string
email			false	string
newPassword			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

updateUser

接口地址:/user/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "birthday": "",
  "gender": "",
  "homepageBg": "",
  "id": 0,
  "interestField": "",
  "lastActiveTime": "",
  "personalSign": "",
  "region": "",
  "themePreference": "",
  "userAvatar": "",
  "userName": "",
  "userProfile": "",
  "userRole": "",
  "userTags": "",
  "visibilitySetting": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userUpdateRequest	userUpdateRequest	body	true	UserUpdateRequest	UserUpdateRequest
birthday			false	string(date-time)
gender			false	string
homepageBg			false	string
id			false	integer(int64)
interestField			false	string
lastActiveTime			false	string(date-time)
personalSign			false	string
region			false	string
themePreference			false	string
userAvatar			false	string
userName			false	string
userProfile			false	string
userRole			false	string
userTags			false	string
visibilitySetting			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

updateUserAvatar

接口地址:/user/update/avatar

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	false	integer(int64)
multipartFile	multipartFile	formData	false	file

响应状态:

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

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	string
message	string

响应示例:

javascript

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

updateUserMultiDeviceLogin

接口地址:/user/update/multi_device_login

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "allowMultiDeviceLogin": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
updateRequest	updateRequest	body	true	UserMultiDeviceLoginUpdateRequest	UserMultiDeviceLoginUpdateRequest
allowMultiDeviceLogin			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

updateUserPermissions

接口地址:/user/update/permissions

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "allowFollow": 0,
  "allowPrivateChat": 0,
  "showFansList": 0,
  "showFollowList": 0,
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
updateRequest	updateRequest	body	true	UserUpdatePermissionsRequest	UserUpdatePermissionsRequest
allowFollow			false	integer(int32)
allowPrivateChat			false	integer(int32)
showFansList			false	integer(int32)
showFollowList			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

user-follows-controller

addUserFollows

接口地址:/userfollows/adduserfollows

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "followStatus": 0,
  "followerId": 0,
  "followingId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userFollowsAddRequest	userFollowsAddRequest	body	true	UserFollowsAddRequest	UserFollowsAddRequest
followStatus			false	integer(int32)
followerId			false	integer(int64)
followingId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

findIsFollow

接口地址:/userfollows/findisfollow

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "followerId": 0,
  "followingId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userFollowsIsFollowsRequest	userFollowsIsFollowsRequest	body	true	UserFollowsIsFollowsRequest	UserFollowsIsFollowsRequest
followerId			false	integer(int64)
followingId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

getFollowAndFansCount

接口地址:/userfollows/getfollowandfanscount/{id}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	path	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«FollowersAndFansVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	FollowersAndFansVO	FollowersAndFansVO
fansCount	integer(int64)
followCount	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"fansCount": 0,
		"followCount": 0
	},
	"message": ""
}

getFollowOrFanList

接口地址:/userfollows/getfolloworfanlist

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "followerId": 0,
  "followingId": 0,
  "pageSize": 0,
  "searchType": 0,
  "userAccountKeyword": "",
  "userNameKeyword": "",
  "userProfileKeyword": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userfollowsQueryRequest	userfollowsQueryRequest	body	true	UserfollowsQueryRequest	UserfollowsQueryRequest
current			false	integer(int64)
followerId			false	integer(int64)
followingId			false	integer(int64)
pageSize			false	integer(int64)
searchType			false	integer(int32)
userAccountKeyword			false	string
userNameKeyword			false	string
userProfileKeyword			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«UserVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«UserVO»	Page«UserVO»
current	integer(int64)
pages	integer(int64)
records	array	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"allowFollow": 0,
				"allowPrivateChat": 0,
				"createTime": "",
				"email": "",
				"fansCount": 0,
				"followCount": 0,
				"homepageBg": "",
				"id": 0,
				"showFansList": 0,
				"showFollowList": 0,
				"userAccount": "",
				"userAvatar": "",
				"userName": "",
				"userProfile": "",
				"userRole": ""
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

getFollowOrFanPicture

接口地址:/userfollows/getfolloworfanpicture

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "category": "",
  "current": 0,
  "endEditTime": "",
  "id": 0,
  "introduction": "",
  "name": "",
  "nullSpaceId": true,
  "pageSize": 0,
  "picColor": "",
  "picFormat": "",
  "picHeight": 0,
  "picScale": 0,
  "picSize": 0,
  "picWidth": 0,
  "reviewMessage": "",
  "reviewStatus": 0,
  "reviewTime": "",
  "reviewerId": 0,
  "searchText": "",
  "sortField": "",
  "sortOrder": "",
  "spaceId": 0,
  "startEditTime": "",
  "tags": [],
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pictureQueryRequest	pictureQueryRequest	body	true	PictureQueryRequest	PictureQueryRequest
category			false	string
current			false	integer(int32)
endEditTime			false	string(date-time)
id			false	integer(int64)
introduction			false	string
name			false	string
nullSpaceId			false	boolean
pageSize			false	integer(int32)
picColor			false	string
picFormat			false	string
picHeight			false	integer(int32)
picScale			false	number(double)
picSize			false	integer(int64)
picWidth			false	integer(int32)
reviewMessage			false	string
reviewStatus			false	integer(int32)
reviewTime			false	string(date-time)
reviewerId			false	integer(int64)
searchText			false	string
sortField			false	string
sortOrder			false	string
spaceId			false	integer(int64)
startEditTime			false	string(date-time)
tags			false	array	string
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«PictureVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«PictureVO»	Page«PictureVO»
current	integer(int64)
pages	integer(int64)
records	array	PictureVO
allowCollect	boolean
allowComment	boolean
allowLike	boolean
allowShare	boolean
category	string
chatCount	integer
commentCount	integer
createTime	string
editTime	string
favoriteCount	integer
id	integer
introduction	string
isDownload	integer
isFavorited	integer
isFeature	integer
isLiked	integer
isShared	integer
likeCount	integer
name	string
permissionList	array	string
picColor	string
picFormat	string
picHeight	integer
picScale	number
picSize	integer
picWidth	integer
recommendScore	number
reviewMessage	string
reviewStatus	integer
shareCount	integer
spaceId	integer
tags	array	string
thumbnailUrl	string
updateTime	string
url	string
user	UserVO	UserVO
allowFollow	integer
allowPrivateChat	integer
createTime	string
email	string
fansCount	integer
followCount	integer
homepageBg	string
id	integer
showFansList	integer
showFollowList	integer
userAccount	string
userAvatar	string
userName	string
userProfile	string
userRole	string
userId	integer
viewCount	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"allowCollect": true,
				"allowComment": true,
				"allowLike": true,
				"allowShare": true,
				"category": "",
				"chatCount": 0,
				"commentCount": 0,
				"createTime": "",
				"editTime": "",
				"favoriteCount": 0,
				"id": 0,
				"introduction": "",
				"isDownload": 0,
				"isFavorited": 0,
				"isFeature": 0,
				"isLiked": 0,
				"isShared": 0,
				"likeCount": 0,
				"name": "",
				"permissionList": [],
				"picColor": "",
				"picFormat": "",
				"picHeight": 0,
				"picScale": 0,
				"picSize": 0,
				"picWidth": 0,
				"recommendScore": 0,
				"reviewMessage": "",
				"reviewStatus": 0,
				"shareCount": 0,
				"spaceId": 0,
				"tags": [],
				"thumbnailUrl": "",
				"updateTime": "",
				"url": "",
				"user": {
					"allowFollow": 0,
					"allowPrivateChat": 0,
					"createTime": "",
					"email": "",
					"fansCount": 0,
					"followCount": 0,
					"homepageBg": "",
					"id": 0,
					"showFansList": 0,
					"showFollowList": 0,
					"userAccount": "",
					"userAvatar": "",
					"userName": "",
					"userProfile": "",
					"userRole": ""
				},
				"userId": 0,
				"viewCount": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

view-record-controller

addViewRecord

接口地址:/view-record/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "targetId": 0,
  "targetType": 0,
  "userId": 0,
  "viewDuration": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
viewRecordAddRequest	viewRecordAddRequest	body	true	ViewRecordAddRequest	ViewRecordAddRequest
targetId			false	integer(int64)
targetType			false	integer(int32)
userId			false	integer(int64)
viewDuration			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

checkHasViewed

接口地址:/view-record/check

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
targetId	targetId	query	true	integer(int64)
targetType	targetType	query	true	integer(int32)
userId	userId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

deleteViewRecord

接口地址:/view-record/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

[]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids	ids	body	true	array	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

listMyViewRecordByPage

接口地址:/view-record/my/list/page

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "current": 0,
  "pageSize": 0,
  "sortField": "",
  "sortOrder": "",
  "targetType": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
viewRecordQueryRequest	viewRecordQueryRequest	body	true	ViewRecordQueryRequest	ViewRecordQueryRequest
current			false	integer(int32)
pageSize			false	integer(int32)
sortField			false	string
sortOrder			false	string
targetType			false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«ViewRecordVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«ViewRecordVO»	Page«ViewRecordVO»
current	integer(int64)
pages	integer(int64)
records	array	ViewRecordVO
createTime	string
id	integer
targetAuthorAvatar	string
targetAuthorUsername	string
targetCover	string
targetId	integer
targetTitle	string
targetType	integer
userId	integer
viewDuration	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"createTime": "",
				"id": 0,
				"targetAuthorAvatar": "",
				"targetAuthorUsername": "",
				"targetCover": "",
				"targetId": 0,
				"targetTitle": "",
				"targetType": 0,
				"userId": 0,
				"viewDuration": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

reportViewDuration

接口地址:/view-record/report-duration

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

[
  {
    "clientTimestamp": 0,
    "duration": 0,
    "targetId": 0,
    "targetType": 0,
    "userId": 0
  }
]

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
requestList	requestList	body	true	array	ReportViewDurationRequest
clientTimestamp			false	integer(int64)
duration			false	integer(int64)
targetId			false	integer(int64)
targetType			false	integer(int32)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

wei-yan-controller

addWeiYan

接口地址:/weiyan/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "content": "",
  "createTime": "",
  "id": 0,
  "isDelete": 0,
  "isPublic": 0,
  "likeCount": 0,
  "loveBoardId": 0,
  "source": 0,
  "type": "",
  "updateTime": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
weiYan	weiYan	body	true	WeiYan	WeiYan
content			false	string
createTime			false	string(date-time)
id			false	integer(int64)
isDelete			false	integer(int32)
isPublic			false	integer(int32)
likeCount			false	integer(int64)
loveBoardId			false	integer(int64)
source			false	integer(int64)
type			false	string
updateTime			false	string(date-time)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«long»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	integer(int64)	integer(int64)
message	string

响应示例:

javascript

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

deleteWeiYan

接口地址:/weiyan/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	true	integer(int64)
loveBoardId	loveBoardId	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

likeWeiYan

接口地址:/weiyan/like

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	true	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

listWeiYan

接口地址:/weiyan/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
loveBoardId	loveBoardId	query	true	integer(int64)
current	current	query	false	integer(int64)
pageSize	pageSize	query	false	integer(int64)
userId	userId	query	false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«Page«WeiYan»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	Page«WeiYan»	Page«WeiYan»
current	integer(int64)
pages	integer(int64)
records	array	WeiYan
content	string
createTime	string
id	integer
isDelete	integer
isPublic	integer
likeCount	integer
loveBoardId	integer
source	integer
type	string
updateTime	string
userId	integer
size	integer(int64)
total	integer(int64)
message	string

响应示例:

javascript

{
	"code": 0,
	"data": {
		"current": 0,
		"pages": 0,
		"records": [
			{
				"content": "",
				"createTime": "",
				"id": 0,
				"isDelete": 0,
				"isPublic": 0,
				"likeCount": 0,
				"loveBoardId": 0,
				"source": 0,
				"type": "",
				"updateTime": "",
				"userId": 0
			}
		],
		"size": 0,
		"total": 0
	},
	"message": ""
}

updateWeiYan

接口地址:/weiyan/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

javascript

{
  "content": "",
  "createTime": "",
  "id": 0,
  "isDelete": 0,
  "isPublic": 0,
  "likeCount": 0,
  "loveBoardId": 0,
  "source": 0,
  "type": "",
  "updateTime": "",
  "userId": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
weiYan	weiYan	body	true	WeiYan	WeiYan
content			false	string
createTime			false	string(date-time)
id			false	integer(int64)
isDelete			false	integer(int32)
isPublic			false	integer(int32)
likeCount			false	integer(int64)
loveBoardId			false	integer(int64)
source			false	integer(int64)
type			false	string
updateTime			false	string(date-time)
userId			false	integer(int64)

响应状态:

状态码	说明	schema
200	OK	BaseResponse«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
data	boolean
message	string

响应示例:

javascript

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

悦目图片管理系统 - API接口文档 ​

activity-controller ​

addActivity ​

deleteActivity ​

getActivityById ​

listCarouselActivities ​

listActivityByPage ​

listActivityBySpaceId ​

reviewActivity ​

ai-chat-controller ​

batchDeleteChat ​

listChatByPageAdmin ​

getChatHistory ​

send ​

app-controller ​

downloadApp ​

getVersionHistory ​

uploadNewVersion ​

getLatestVersion ​

audio-file-controller ​

batchDeleteAudio ​

listAudioByPageAdmin ​

listAudioByPage ​

uploadAudio ​

getAudioById ​

deleteAudio ​

bug-report-controller ​

addBugReport ​

solveBugReport ​

deleteBugReport ​

getBugReportById ​

listBugReportByPage ​

listMyBugReportByPage ​

updateBugReport ​

category-controller ​

addCategory ​

deleteCategory ​

listCategoryVO ​

listCategoryByType ​

findCategory ​

chat-message-controller ​

batchOperationMessages ​

getMessageById ​

listMessagesByPage ​

updateMessage ​

comments-controller ​

addComment ​

batchOperationComments ​

getCommentedHistory ​

deleteComment ​

getCommentById ​

likeComment ​

listCommentsByPage ​

getMyCommentHistory ​

queryComment ​

getUnreadComments ​

getUnreadCommentsCount ​

updateComment ​

dashboard-controller ​

getChartStats ​

getDashboardStats ​

favorite-record-controller ​

addFavoriteRecord ​

cancelFavorite ​

checkHasFavorited ​

getFavoriteHistory ​

getMyFavoriteHistory ​

getUnreadFavorites ​

getUnreadFavoritesCount ​

file-controller ​

testDownloadFile ​

testUploadFile ​

file-upload-controller ​

commonUploadAudio ​

commonUploadPicture ​

friend-link-controller ​

addFriendLink ​

increaseClickCount ​

countByType ​

deleteFriendLink ​

悦目图片管理系统 - API接口文档

activity-controller

addActivity

deleteActivity

getActivityById

listCarouselActivities

listActivityByPage

listActivityBySpaceId

reviewActivity

ai-chat-controller

batchDeleteChat

listChatByPageAdmin

getChatHistory

send

app-controller

downloadApp

getVersionHistory

uploadNewVersion

getLatestVersion

audio-file-controller

batchDeleteAudio

listAudioByPageAdmin

listAudioByPage

uploadAudio

getAudioById

deleteAudio

bug-report-controller

addBugReport

solveBugReport

deleteBugReport

getBugReportById

listBugReportByPage

listMyBugReportByPage

updateBugReport

category-controller

addCategory

deleteCategory

listCategoryVO

listCategoryByType

findCategory

chat-message-controller

batchOperationMessages

getMessageById

listMessagesByPage

updateMessage

comments-controller

addComment

batchOperationComments

getCommentedHistory

deleteComment

getCommentById

likeComment

listCommentsByPage

getMyCommentHistory

queryComment

getUnreadComments

getUnreadCommentsCount

updateComment

dashboard-controller

getChartStats

getDashboardStats

favorite-record-controller

addFavoriteRecord

cancelFavorite

checkHasFavorited

getFavoriteHistory

getMyFavoriteHistory

getUnreadFavorites

getUnreadFavoritesCount

file-controller

testDownloadFile

testUploadFile

file-upload-controller

commonUploadAudio

commonUploadPicture

friend-link-controller

addFriendLink

increaseClickCount

countByType

deleteFriendLink