UCG后台管理系统

图书馆

GET 获取图书分类 /api/book/categoryList

获取图书分类

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
type	string	是	分类类别

正文

无

参数

追加

响应输出

返回参数

无

无

POST 添加图书收藏 /api/book/addBookToCollection

添加图书收藏

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
bookId	string	是	书籍ID

正文

无

参数

追加

响应输出

返回参数

无

无

POST 兑换书籍 /api/book/bookBuy

兑换书籍

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
bookId	string	是	书籍ID

正文

无

参数

追加

响应输出

返回参数

无

无

POST 查询是否拥有书籍 /api/book/ownerBook

查询是否拥有书籍

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
bookId	string	是	书籍ID

正文

无

参数

追加

响应输出

返回参数

无

无

POST 删除用户笔记 /api/book/deleteBookNote

删除用户笔记

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	是	笔记ID

正文

无

参数

追加

响应输出

返回参数

无

无

POST 添加用户书籍笔记 /api/book/addBookNotes

添加用户书籍笔记

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
bookId	string	是	书籍ID
content	string	是	笔记内容

正文

无

参数

追加

bookId

content

响应输出

返回参数

无

无

GET 获取用户书籍笔记 /api/book/getBookNotes

获取用户书籍笔记

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
bookId	string	是	书籍ID
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

bookId

offset

limit

响应输出

返回参数

无

无

POST 取消图书收藏 /api/book/deleteBookToCollection

取消图书收藏

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	是	书籍收藏ID

正文

无

参数

追加

响应输出

返回参数

无

无

GET 获取用户收藏书籍分类 /api/book/getUserBookCollectionType

获取用户收藏书籍分类

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

offset

limit

响应输出

返回参数

无

无

GET 获取分类图书列表 /api/book/categoryBookList

获取分类图书列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
typeId	string	是	分类ID
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

typeId

offset

limit

响应输出

返回参数

无

无

GET 获取用户图书收藏列表 /api/book/getBookCollection

获取用户图书收藏列表

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

offset

limit

响应输出

返回参数

无

无

GET 获取图书相关链接 /api/book/getBookExtLink

获取图书相关链接

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
bookId	string	是	书籍ID
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

bookId

offset

limit

响应输出

返回参数

无

无

POST 添加图书评论 /api/book/addBookComment

添加图书评论

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
bookId	string	是	书籍ID
content	string	是	评论内容

正文

无

参数

追加

bookId

content

响应输出

返回参数

无

无

GET 获取图书评论 /api/book/getBookComment

获取图书评论

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
bookId	string	是	书籍ID
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

bookId

offset

limit

响应输出

返回参数

无

无

GET 获取图书详情 /api/book/getBookDetail

获取图书详情

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
bookDetailId	string	是	书籍详情ID

正文

无

参数

追加

响应输出

返回参数

无

无

GET 获取图书章节 /api/book/getBookChapter

获取图书章节

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
bookId	string	是	书籍ID

正文

无

参数

追加

响应输出

返回参数

无

无

GET 新游戏发售列表 /api/book/newGameList

新游戏发售列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
startDate	string	是	开始日期（2022-01-12）
endDate	string	是	结束日期（2022-01-12）
keyword	string	是	标题

正文

无

参数

追加

startDate

endDate

keyword

响应输出

返回参数

无

无

公共接口

GET 加载初始化 /api/common/init

加载初始化

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
version	string	是	版本号
lng	string	是	经度
lat	string	是	纬度

正文

无

参数

追加

version

lng

lat

响应输出

返回参数

无

无

POST 上传文件 /api/common/upload

上传文件

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
file	File	是	文件流

正文

无

参数

追加

响应输出

返回参数

无

无

POST 获取广告 /api/common/ad

获取广告

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
code	String	是	广告位置代码

正文

无

参数

追加

响应输出

返回参数

无

无

POST 获取轮播图 /api/common/banner

获取轮播图

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
code	String	是	轮播图位置代码

正文

无

参数

追加

响应输出

返回参数

无

无

GET 获取获取单页html /api/common/onepage

获取获取单页html

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
code	String	是	单页代码
reader	String	是	json或者html

正文

无

参数

追加

code

reader

响应输出

返回参数

无

无

GET 获取系统头像挂件列表 /api/common/getAvatarWidgetList

获取系统头像挂件列表

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 获取配置信息 /api/common/getConfig

获取配置信息

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
code	String	是	配置代码

正文

无

参数

追加

响应输出

返回参数

无

无

GET 生成兑换key /api/common/generateKey

生成兑换key

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

社区API

GET 获取最新动态 /api/community/newDynamicList

获取最新动态

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

offset

limit

响应输出

返回参数

无

无

POST 文章收藏列表 /api/community/articleCollectionList

文章收藏列表

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
offset	int	是	偏移
limit	int	是	数量
category_name	int	是	分类名称
search_key	int	是	搜索文章标题

正文

无

参数

追加

offset

limit

category_name

search_key

响应输出

返回参数

无

无

GET 用户是否参加抽奖 /api/community/checkJoinLottery

用户是否参加抽奖

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
lotteryId	int	是	抽奖活动ID
userId	int	是	用户ID

正文

无

参数

追加

lotteryId

userId

响应输出

返回参数

无

无

POST 参加抽奖活动 /api/community/joinLottery

参加抽奖活动

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
lotteryId	int	是	抽奖活动ID

正文

无

参数

追加

响应输出

返回参数

无

无

GET 获取抽奖详情 /api/community/getLotteryDetail

获取抽奖详情

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
lotteryId	int	是	抽奖活动ID

正文

无

参数

追加

响应输出

返回参数

无

无

GET 获取抽奖列表 /api/community/getLotteryList

获取抽奖列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

offset

limit

响应输出

返回参数

无

无

POST 发布动态 /api/community/pushDynamic

发布动态

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
content	string	是	内容
images	string	是	图片

正文

无

参数

追加

content

images

响应输出

返回参数

无

无

GET 获取精选内容接口-- /api/community/getSelectContentList

获取精选内容接口--

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
bookId	string	是	书籍ID

正文

无

参数

追加

响应输出

返回参数

无

无

GET 文章评论列表 /api/community/articleCommentList

文章评论列表

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	文章ID
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

id

offset

limit

响应输出

返回参数

无

无

POST 添加文章评论 /api/community/articleAddComment

添加文章评论

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	文章ID
content	int	是	内容

正文

无

参数

追加

id

content

响应输出

返回参数

无

无

POST 文章收藏 /api/community/articleCollection

文章收藏

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	文章ID
category_name	int	是	分类名称

正文

无

参数

追加

id

category_name

响应输出

返回参数

无

无

POST 动态详情 /api/community/dynamicDetail

动态详情

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是

正文

无

参数

追加

响应输出

返回参数

无

无

GET 获取文章详情-- /api/community/getArticleDetail

获取文章详情--

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	是	文章ID

正文

无

参数

追加

响应输出

返回参数

无

无

GET 获取文章分类接口 /api/community/getArticleCategoryList

获取文章分类接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
typeId	string	是	分类ID
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

typeId

offset

limit

响应输出

返回参数

无

无

POST 添加动态评论 /api/community/dynamicAddComment

添加动态评论

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	动态ID
content	int	是	内容

正文

无

参数

追加

id

content

响应输出

返回参数

无

无

GET 动态评论列表 /api/community/dynamicCommentList

动态评论列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	动态ID
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

id

offset

limit

响应输出

返回参数

无

无

POST 动态收藏列表 /api/community/dynamicCollectionList

动态收藏列表

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

offset

limit

响应输出

返回参数

无

无

POST 动态收藏 /api/community/dynamicCollection

动态收藏

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是

正文

无

参数

追加

响应输出

返回参数

无

无

POST 文章点赞 /api/community/articleLike

文章点赞

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是

正文

无

参数

追加

响应输出

返回参数

无

无

POST 动态点赞 /api/community/dynamicLike

动态点赞

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是

正文

无

参数

追加

响应输出

返回参数

无

无

GET 获取其他用户信息 /api/community/toUserInfo

获取其他用户信息

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	用户ID

正文

无

参数

追加

响应输出

返回参数

无

无

示例接口

POST 测试名称 /api/demo/test/id/{id}/name/{name}

测试描述信息

权限

登录	否
鉴权	否

Headers

名称	类型	必选	描述
token	string	是	请求的Token

参数

名称	类型	必选	描述
id	integer	是	会员ID
name	string	是	用户名
data	object	是	扩展数据

正文

无

Headers

token

参数

追加

id

name

data

响应输出

返回参数

名称	类型	描述
code	integer
msg	string
data	object	扩展数据返回

{
         'code':'1',
         'msg':'返回成功'
        }

GET 无需登录的接口 /api/demo/test1

无需登录的接口

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 需要登录的接口 /api/demo/test2

需要登录的接口

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 需要登录且需要验证有相应组的权限 /api/demo/test3

需要登录且需要验证有相应组的权限

权限

登录	是
鉴权	是

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

邮箱验证码接口

POST 发送验证码 /api/ems/send

发送验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
event	string	是	事件名称

正文

无

参数

追加

email

event

响应输出

返回参数

无

无

POST 检测验证码 /api/ems/check

检测验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
event	string	是	事件名称
captcha	string	是	验证码

正文

无

参数

追加

email

event

captcha

响应输出

返回参数

无

无

会员接口

POST 会员登录 /api/user/login

会员登录

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
account	string	是	账号
password	string	是	密码

正文

无

参数

追加

account

password

响应输出

返回参数

无

无

POST 拉黑 /api/user/toBlacklist

拉黑

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
black_user_id	string	是	取消拉黑用户id

正文

无

参数

追加

响应输出

返回参数

无

无

GET 积分变动记录 /api/user/getUserScoreLog

积分变动记录

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

offset

limit

响应输出

返回参数

无

无

GET 我的发布文章视频列表 /api/user/getArticleCategoryList

我的发布文章视频列表

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
typeId	string	是	分类ID
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

typeId

offset

limit

响应输出

返回参数

无

无

GET 我的发布动态列表 /api/user/getMyDynamicList

我的发布动态列表

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

offset

limit

响应输出

返回参数

无

无

GET 关注用户 /api/user/follow

关注用户

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	是	被关注用户ID

正文

无

参数

追加

响应输出

返回参数

无

无

GET 检查自己是否已关注用户 /api/user/checkFollow

检查自己是否已关注用户

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	是	被关注用户ID

正文

无

参数

追加

响应输出

返回参数

无

无

POST 注销账户 /api/user/accountClose

注销账户

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
code	string	是	验证码

正文

无

参数

追加

响应输出

返回参数

无

无

POST 兑换文章 /api/user/exchangeKey

兑换文章

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
cdkey	string	是	兑换码

正文

无

参数

追加

响应输出

返回参数

无

无

POST 黑名单 /api/user/blacklist

黑名单

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

offset

limit

响应输出

返回参数

无

无

POST 取消拉黑 /api/user/cancelBlacklist

取消拉黑

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
black_user_id	string	是	取消拉黑用户id

正文

无

参数

追加

响应输出

返回参数

无

无

POST 兑换商品接口 /api/user/addExchangeCenter

兑换商品接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
goodId	int	是	商品ID

正文

无

参数

追加

响应输出

返回参数

无

无

POST 书籍评论投诉接口 /api/user/bookCommentReport

书籍评论投诉接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	是	书籍评论ID
content	string	是	投诉内容

正文

无

参数

追加

id

content

响应输出

返回参数

无

无

POST 动态投诉接口 /api/user/dynamicReport

动态投诉接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	是	动态ID
content	string	是	投诉内容

正文

无

参数

追加

id

content

响应输出

返回参数

无

无

POST 动态评论投诉接口 /api/user/dynamicCommentReport

动态评论投诉接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	是	动态ID
content	string	是	投诉内容

正文

无

参数

追加

id

content

响应输出

返回参数

无

无

POST 文章投诉接口 /api/user/articleReport

文章投诉接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	是	文章评论ID
content	string	是	投诉内容

正文

无

参数

追加

id

content

响应输出

返回参数

无

无

POST 文章评论投诉接口 /api/user/articleCommentReport

文章评论投诉接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	是	文章评论ID
content	string	是	投诉内容

正文

无

参数

追加

id

content

响应输出

返回参数

无

无

POST 自定义收藏分类添加 /api/user/customCollectionType

自定义收藏分类添加

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
name	string	是	分类名称

正文

无

参数

追加

响应输出

返回参数

无

无

POST 获取自定义收藏分类 /api/user/getCustomCategory

获取自定义收藏分类

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 自定义分类移动 /api/user/moveCustomCategory

自定义分类移动

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
ids	string	是	文章ID
category_name	string	是	分类名称

正文

无

参数

追加

ids

category_name

响应输出

返回参数

无

无

GET 征稿列表 /api/user/getContributionsList

征稿列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
offset	int	是	偏移
limit	int	是	数量
status	int	是	0=进行中

正文

无

参数

追加

offset

limit

status

响应输出

返回参数

无

无

GET 兑换中心列表 /api/user/getExchangeCenterList

兑换中心列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

offset

limit

响应输出

返回参数

无

无

POST 手机验证码登录 /api/user/mobilelogin

手机验证码登录

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
captcha	string	是	验证码

正文

无

参数

追加

mobile

captcha

响应输出

返回参数

无

无

POST 重置密码 /api/user/resetpwd

重置密码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
newpassword	string	是	新密码
captcha	string	是	验证码

正文

无

参数

追加

mobile

newpassword

captcha

响应输出

返回参数

无

无

POST 注册会员 /api/user/register

注册会员

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
username	string	是	用户名
password	string	是	密码
email	string	是	邮箱
mobile	string	是	手机号
code	string	是	验证码

正文

无

参数

追加

username

password

email

mobile

code

响应输出

返回参数

无

无

POST 退出登录 /api/user/logout

退出登录

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 会员信息 /api/user/userinfo

会员信息

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 修改会员个人信息(头像、用户名、昵称) /api/user/profile

修改会员个人信息(头像、用户名、昵称)

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
avatar	string	是	头像地址
username	string	是	用户名
nickname	string	是	昵称

正文

无

参数

追加

avatar

username

nickname

响应输出

返回参数

无

无

POST 游戏币兑换昵称修改次数 /api/user/coin2ChangeNumber

游戏币兑换昵称修改次数

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
changeNumber	string	是	兑换修改次数

正文

无

参数

追加

响应输出

返回参数

无

无

POST 修改邮箱 /api/user/changeemail

修改邮箱

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
captcha	string	是	验证码

正文

无

参数

追加

email

captcha

响应输出

返回参数

无

无

POST 修改手机号 /api/user/changemobile

修改手机号

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
captcha	string	是	验证码

正文

无

参数

追加

mobile

captcha

响应输出

返回参数

无

无

POST 第三方登录 /api/user/third

第三方登录

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
platform	string	是	平台名称
code	string	是	Code码

正文

无

参数

追加

platform

code

响应输出

返回参数

无

无

GET 签到积分信息 /api/user/getSigninInfo

签到积分信息

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 用户粉丝列表 /api/user/getFansMessages

用户粉丝列表

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

offset

limit

响应输出

返回参数

无

无

POST 签到 /api/user/signin

签到

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 当周签到信息 /api/user/getWeekSigninInfo

当周签到信息

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 用户头像挂件列表 /api/user/getUserAvatarWidget

用户头像挂件列表

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 设置用户头像挂件 /api/user/setUserAvatarWidget

设置用户头像挂件

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	挂件ID

正文

无

参数

追加

响应输出

返回参数

无

无

GET 个人系统未读消息数量 /api/user/getSysUnReadMessage

个人系统未读消息数量

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 个人系统消息列表 /api/user/getSysMessages

个人系统消息列表

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

offset

limit

响应输出

返回参数

无

无

GET @消息列表 /api/user/getToyouMessages

@消息列表

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

offset

limit

响应输出

返回参数

无

无

GET 点赞消息列表 /api/user/getLikeMessages

点赞消息列表

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

offset

limit

响应输出

返回参数

无

无

GET 用户关注列表 /api/user/getFocusMessages

用户关注列表

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
offset	int	是	偏移
limit	int	是	数量

正文

无

参数

追加

offset

limit

响应输出

返回参数

无

无

POST 文章批量取消收藏 /api/user/cancelArticleCollection

文章批量取消收藏

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
ids	int	是	文章ID

正文

无

参数

追加

响应输出

返回参数

无

无

首页接口

GET 首页 /api/index/index

首页

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

手机短信接口

POST 发送验证码 /api/sms/send

发送验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
event	string	是	事件名称

正文

无

参数

追加

mobile

event

响应输出

返回参数

无

无

POST 检测验证码 /api/sms/check

检测验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
event	string	是	事件名称
captcha	string	是	验证码

正文

无

参数

追加

mobile

event

captcha

响应输出

返回参数

无

无

Token接口

GET 检测Token是否过期 /api/token/check

检测Token是否过期

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 刷新Token /api/token/refresh

刷新Token

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

验证接口

POST 检测邮箱 /api/validate/check_email_available

检测邮箱

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
id	string	是	排除会员ID

正文

无

参数

追加

email

id

响应输出

返回参数

无

无

POST 检测用户名 /api/validate/check_username_available

检测用户名

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
username	string	是	用户名
id	string	是	排除会员ID

正文

无

参数

追加

username

id

响应输出

返回参数

无

无

POST 检测昵称 /api/validate/check_nickname_available

检测昵称

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
nickname	string	是	昵称
id	string	是	排除会员ID

正文

无

参数

追加

nickname

id

响应输出

返回参数

无

无

POST 检测手机 /api/validate/check_mobile_available

检测手机

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
id	string	是	排除会员ID

正文

无

参数

追加

mobile

id

响应输出

返回参数

无

无

POST 检测手机 /api/validate/check_mobile_exist

检测手机

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号

正文

无

参数

追加

响应输出

返回参数

无

无

POST 检测邮箱 /api/validate/check_email_exist

检测邮箱

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	邮箱

正文

无

参数

追加

响应输出

返回参数

无

无

POST 检测手机验证码 /api/validate/check_sms_correct

检测手机验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
captcha	string	是	验证码
event	string	是	事件

正文

无

参数

追加

mobile

captcha

event

响应输出

返回参数

无

无

POST 检测邮箱验证码 /api/validate/check_ems_correct

检测邮箱验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
captcha	string	是	验证码
event	string	是	事件

正文

无

参数

追加

email

captcha

event

响应输出

返回参数

无

无