[深圳|结业弟子]JAVA-张庆东|2017年11月16日的日报-技能树.IT修真院

发表于： 2017-11-16 23:35:50

2 536

今天完成的事情：

1.基本上完成接口文档

不知道为什么，越写越觉得有问题，以及下面我觉得类型有问题的没填

签到：

请求地址： put /a/u/sign

返回参数：

字段	说明	类型
code	状态码	number
message	消息	string
data	数据

字段	说明	类型	备注
signBean	签到给的豆子	number

签到信息：

请求地址： get a/u/sign/message

返回参数：

字段	说明	类型
code	状态码	number
message	消息	string
data	数据

data

字段	说明	类型	备注
username	用户名	string
avatar	用户头像	string	url
beans	逆袭豆总数	number
signHistory	当月签到历史	array
maxSignNum	最高签到天数	number
totalSign	签到总数	number

视频列表

请求地址： get /a/u/video/list

请求参数：

字段	说明	类型	是否必填	备注
title	标题	String	否
grade	年级	number	否
subject	科目	number	否

返回参数

字段	说明	类型
code	状态码	number
message	消息	string
data	数据	object

data

字段	说明	类型	备注
banner	轮播图	array
card	展示视频	array

Banner图

字段	说明	类型	是否必填	备注
id	视频id	Number	是
cover	视频封面	string	是
url	视频地址	string	否

说明：这里传过来的banner图数据时视频表中类型为banner图，且状态为“上架状态”，最多为8个

Card

字段	说明	类型	备注
id	视频id	number
title	视频标题	string
intro	视频简介	string
teacherName	老师名	string
teacherAvatar	老师头像	string
upvote	点赞数	number
collection	收藏数	number
upvoteStatus	点赞状态	number	点赞为1，非点赞为2，默认为2
collectionStatus	收藏状态	number	收藏为1，非收藏为2，默认为2
publishTime	发表时间	number

视频详情：

请求地址： get /a/u/video/{id}

返回参数

字段	说明	类型	备注
title	视频标题	string
intro	视频简介	string
publishTime	发表时间	number
teacherName	老师名	string
upvote	点赞数	number
collection	收藏数	number
upvoteStatus	点赞状态	number	点赞为1，非点赞为2，默认为2
collectionStatus	收藏状态	number	收藏为1，非收藏为2，默认为2
video	视频url	string

字段	说明	类型	备注
title	视频标题	string
text	视频正文	string

视频点赞：

请求地址： put /a/u/video/upvote/{id}

请求参数：

字段	说明	类型	备注
userUpvote	用户点赞/取消点赞	number	点赞：1/取消：2

返回参数

字段	说明	类型
code	状态码	number
message	消息	string

视频收藏：

请求地址： put /a/u/video/collection/{id}

请求参数：

字段	说明	类型	备注
userCollect	用户收藏/取消收藏	number	收藏：1/取消：2

返回参数

字段	说明	类型
code	状态码	number
message	消息	string

后台：

视频列表：

请求地址： get /a/u/video

请求参数

字段	说明	类型	备注
title	视频标题	number
title	视频标题	number
subject	科目	string
type	类型	string	banner、card、all
class	年级	number	初一：1 初二：2 初三：3 高一：4 高二：5 ：高三：6 全部：0
upvote	点赞数	number
collection	收藏数	number
pageSize	每页展示数	number
page	第几页	number

返回参数：

字段	说明	类型
code	状态码	number
message	消息	string
data	数据	array

data

字段	说明	类型	备注
title	视频标题	number
subject	科目	string
title	视频标题	number
type	类型		banner、card、all
class	年级	number	初一：1 初二：2 初三：3 高一：4 高二：5 ：高三：6 全部：0
upvote	点赞数	number
collection	收藏数	number
teacherName	老师名	string
status	上架状态	number	上架：1 下架：2

新增视频：

请求地址 post /a/u/video/{id}

请求参数：

若分类为banner图

字段	说明	类型	是否必填	备注
cover	视频封面	string	是
class	年级	string	否
subject	科目	string	否
teacherName	老师名	string	否
teacherAvatar	老师头像	string	否
title	视频标题	string	否
type	视频类型	string	是	选定banner
intro	视频简介	string	否
video	视频地址	string	否	视频url
text	视频正文	string	否

返回参数：

字段	说明	类型
code	状态码	number
message	消息	string

若分类为card

请求参数

字段	说明	类型	是否必填	备注
class	年级	string	是
subject	科目	string	是
teacherName	老师名	string	是
teacherAvatar	老师头像	string	是
title	视频标题	string	是
type	视频类型	string	是	card
intro	视频简介	string	是
video	视频地址	string	是	视频url
text	视频正文	string	是