发表于： 2017-11-26 23:45:43
1 746
今天完成的事情：
我负责模块的前后端约定：
约定：
通用
1. 列表。前台的用户模块的视频/文藏收藏列表，文学部模块的文章列表，视频部的视频列表，以及后台的视频列表、文章列表皆可以填入两个请求参数，size和page。这两个参数分别代表后端数据库的分页查询的每页数据数和第几页。两个参数可以为空，若为空，则默认为10和1
2. 上传。/a/upload/{model}中的{model}为模块名，在哪个模块上传则填写哪个模块的名字。对应模块名称分别为：文学部：article，视频部：video，用户模块：user。上传后返回url
前台视频：
1. 前台视频列表：
1.1 年级（class）。初一到高一别用数字1~6表示，整个初中部用数字7表示，整个高中部用数字8表示，
1.2 科目（subject）。语文、数学，英语，物理，化学，生物，历史，地理，政治分别用数字1、2、3、4、5、6、7、8、9表示，全部科目用0表示
2.前台视频详情
2.1 点赞状态（upvoteStatus）。未点赞状态用1表示，已点赞状态用2表示
后台视频：
1. 后台视频列表
1.1 分类（type）。banner图即轮播图，用banner表示；card视频即普通视频，用card表示
1.2 年级（class）。初一到高一分别用数字1~6表示；全部用0表示。
1.3 科目（subject）。科目（subject）。语文、数学，英语，物理，化学，生物，历史，地理，政治分别用数字1、2、3、4、5、6、7、8、9表示，全部科目用0表示
1.4 上架状态（status）。上架状态用数字1表示，下架状态用数字2表示
2. 新增、编辑、视频详情
2.1 年级（class）。初一到高一分别用数字1~6表示；其他用9表示。
2.2 科目（subject）。科目（subject）。语文、数学，英语，物理，化学，生物，历史，地理，政治分别用数字1、2、3、4、5、6、7、8、9表示，其他用10表示
2.3 分类（type）。banner图即轮播图，用banner表示；card视频即普通视频，用card表示
我负责模块的前台接口文档：
通用
上传图片：
请求地址：get /a/upload/{model}
请求参数：
字段 | 说明 | 类型 | 备注 |
待定 | 待定 | 待定 | 文件流 |
返回参数：
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
data | 数据 | object |
data
字段 | 说明 | 类型 |
url | 图片地址 | string |
一、微信部分
1. 获取用户openid、用户信息
请求地址： get /a/wechat/message
返回参数：
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
data | 数据 | object |
data
字段 | 说明 | 类型 | 备注 |
openid | 用户的标识，对当前公众号唯一 | string |
|
nickname | 用户的昵称 | string |
|
sex | 用户性别 | number | 1为男性，2为女性，0为未知 |
city | 用户所在城市 | string |
|
country | 用户所在国家 | string |
|
province | 用户所在省份 | string |
|
headimgurl | 用户头像 | string | 头像链接地址 |
2. 获取用户access_token
请求地址：get /a/wechat/accesstoken
返回参数：
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
data | 数据 | object |
data
字段 | 说明 | 类型 | 备注 |
accessToken | 公众号的全局唯一接口调用凭据 | string |
|
3. 更新access_token
请求地址: put /a/wechat/accesstoken
返回参数：
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
4. 验证请求是否来自微信
请求地址：get a/wechat/ signature
返回参数：
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
data | 数据 | object |
data
字段 | 说明 | 类型 | 备注 |
timestamp | 时间戳 | string |
|
nonceStr | 消息 | string |
|
signature | 签名 | string |
|
二、签到部分（门卫处）
1.签到页面展示
请求地址：get /a/u/sign
返回参数：
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
data | 数据 | object |
data
字段 | 说明 | 类型 | 备注 |
username | 用户名 | string |
|
avatar | 用户头像 | string | url |
beans | 逆袭豆总数 | number |
|
signHistory | 当月签到历史 | array |
|
maxSignNum | 最高连续签到 | number |
|
nowSignNum | 当前连续签到 | number |
|
totalSignNum | 签到总天数数 | number |
|
2.用户签到（行为）
请求地址：put /a/u/sign
返回参数：
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
三、视频部
1. 视频列表
请求地址： get /a/u/user/video/list
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
title | 标题 | string | 否 |
|
grade | 年级 | number | 否 |
|
subject | 科目 | number | 否 |
|
size | 分页查询数据数 | number | 否 |
|
page | 分页查询页码 | number | 否 |
|
返回参数
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
data | 数据 |
|
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 |
|
2. 视频详情
请求地址： get /a/u/user/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 |
|
3.视频点赞
请求地址： put /a/u/video/upvote/{id}
请求参数：
字段 | 说明 | 类型 | 备注 |
userUpvote | 用户点赞/取消点赞 | number | 点赞：1/取消：2 |
返回参数
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
4.视频收藏
请求地址： put /a/u/user/video/collection/{id}
请求参数：
字段 | 说明 | 类型 | 备注 |
userCollect | 用户收藏/取消收藏 | number | 收藏：1/取消：2 |
返回参数
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
我负责模块的后台接口文档：
一、视频部分
1. 视频列表
请求地址： get /a/u/video
请求参数
字段 | 说明 | 类型 | 备注 |
title | 视频标题 | number |
|
subject | 科目 | string |
|
type | 类型 | string | banner、card、all |
class | 年级 | number | 初一：1 初二：2 初三：3 高一：4 高二：5 ：高三：6 全部：0 |
minUpvote | 点赞数下限 | number |
|
maxUpvote | 点赞数上限 | number |
|
minCollection | 收藏数下限 | number |
|
maxCollection | 收藏数下限 | number |
|
pageSize | 每页展示数 | number |
|
page | 第几页 | number |
|
返回参数：
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
data | 数据 | array |
data
字段 | 说明 | 类型 | 备注 |
vId | 视频id | number |
|
title | 视频标题 | number |
|
subject | 科目 |
|
|
title | 视频标题 | number |
|
type | 类型 |
| banner、card、all |
class | 年级 | number | 初一：1 初二：2 初三：3 高一：4 高二：5 ：高三：6 全部：0 |
upvote | 点赞数 | number |
|
collection | 收藏数 | number |
|
teacherName | 老师名 |
|
|
status | 上架状态 | number | 上架：1 下架：2 |
1.1上/下架视频
请求地址：put /a/u/video/{id}/status
请求参数：
字段 | 说明 | 类型 | 备注 |
vId | 视频id | number |
|
status | 上架状态 | number |
|
返回参数：
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
2. 新增视频
请求参数：
若分类（下表中type）为banner图
字段 | 说明 | 类型 | 是否必填 | 备注 |
cover | 视频封面 | string | 是 |
|
class | 年级 | string | 否 |
|
subject | 科目 | string | 否 |
|
teacherName | 老师名 | string | 否 |
|
teacherAvatar | 老师头像 | string | 否 |
|
title | 视频标题 | string | 否 |
|
type | 视频类型 | string | 是 | 选定banner |
intro | 视频简介 | string | 否 |
|
video | 视频地址 | string | 否 | 视频url |
text | 视频正文 | string | 否 |
|
若分类（下表中type）为card
请求参数
字段 | 说明 | 类型 | 是否必填 | 备注 |
class | 年级 | string | 是 |
|
subject | 科目 | string | 是 |
|
teacherName | 老师名 | string | 是 |
|
teacherAvatar | 老师头像 | string | 是 |
|
title | 视频标题 | string | 是 |
|
type | 视频类型 | string | 是 | 选定card |
intro | 视频简介 | string | 是 |
|
video | 视频地址 | string | 是 | 视频url |
text | 视频正文 | string | 是 |
|
3. 编辑视频
请求地址：put /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 | 否 |
|
若分类为card
请求参数
字段 | 说明 | 类型 | 是否必填 | 备注 |
class | 年级 | string | 是 |
|
subject | 科目 | string | 是 |
|
teacherName | 老师名 | string | 是 |
|
teacherAvatar | 老师头像 | string | 是 |
|
title | 视频标题 | string | 是 |
|
type | 视频类型 | string | 是 | 选定card |
intro | 视频简介 | string | 是 |
|
video | 视频地址 | string | 是 | 视频url |
text | 视频正文 | string | 是 |
|
返回参数：
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
注：编辑中所需要的参数请到“查看视频详情的接口中取数据”
4. 查看视频
请求地址： get /a/u/video/{vid}/detail
返回参数：
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
data | 数据 | object |
data
字段 | 说明 | 类型 | 备注 |
vId | 视频id | number |
|
class | 年级 | number |
|
subject | 科目 | number |
|
teacherName | 老师姓名 | string |
|
teacherAvatar | 老师头像 | string | url |
title | 视频标题 | string |
|
type | 视频分类 | string |
|
cover | 视频封面 | string |
|
intro | 视频简介 | string |
|
video | 视频地址 | string |
|
text | 视频正文 | string |
|
注：在“查看视频详情”，也就是这个接口中，“视频分类”和“视频封面”这两个数据时多余的，但是为了能为“编辑视频”接口提供数据，把这两个数据加上了、
二、老师部分
1. 老师列表
请求地址： get /a/u/teacher/list
返回参数：
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
data | 数据 | array |
data
字段 | 说明 | 类型 | 备注 |
tId | 老师id | number |
|
teacherName | 老师名字 | string |
|
teacherAvatar | 老师头像 | string |
|
2. 新增老师
请求地址 post /a/u/teacher
请求参数：
字段 | 说明 | 类型 | 备注 |
teacherName | 老师名字 | string |
|
teacherAvatar | 老师头像 | url |
|
返回参数：
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
3. 删除老师
请求地址： delete /a/u/teacher/{id}
返回参数：
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
明天计划的事情：
完成方案设计，并设计表，看看能不能使用代码生成运行一下
遇到的问题：
无
收获：
完成了接口文档
进度：
接口文档已完成，开始方案设计和设计表
返回列表
评论