发表于： 2018-09-10 23:21:55

0 408

今日完成：

将接口文档修改，整理

一、首页

1. 签到页

约定

signDays ：采用二进制 0010101010101

请求地址： GET /user/{uid}/sign
请求参数：用户 uid

字段	说明	类型	是否必须	备注
uid	用户id	number	是

返回参数：

字段	说明	类型	备注
code	状态码	numbei
message	状态信息	String
data	数据	json

data

字段	说明	类型	备注
headPic	用户头像	String
nickname	用户昵称	String
signTime	最后一次签到时间	date
signState	签到状态	boolean	true 已签到；false未签到
signTag	签到详情	Array	0未签到；1签到
signDays	连续签到天数	number
signScore	逆袭豆	number

2. 签到按钮

请求地址： POST /user/{uid}/sign
请求参数：用户 uid

字段	说明	类型	是否必须	备注
uid	用户id	number	是

返回参数：

字段	说明	类型	备注
code	状态码	number
message	状态信息	String
data	数据	json

data

字段	说明	类型	备注
sigenState	签到状态	boolean	true 已签到；false未签到
getScore	获得的逆袭豆	number	连续签到获得的逆袭豆（前5天score = 天数，5天后，每次增加5分）

二、前台

1. 学生证

请求地址： GET /user/{uid}/card
请求参数：用户id

字段	说明	类型	是否必须	备注
uid	用户id	number	是

返回参数：

字段	说明	类型	备注
code	状态码	number
message	错误信息	String
data	数据	json

data

字段	说明	类型	备注
headPic	用户头像	String
nickname	用户昵称	String
headPic	头像	String
grade	年级	number	0：未设置；1-6：代表初一至高三
signScore	逆袭豆	number
boundState	账号绑定状态

2. 编辑学生证

请求地址： POST /user/{uid}/card
请求参数

字段	说明	类型	是否必须	备注
uid	用户id	number
nickname	用户昵称	String	否
headPic	头像	String	否
grade	年级	number	否	1-6：代表初一至高三

返回参数

字段	说明	类型	备注
code	状态码	number
message	状态信息	String

3. 我的收藏

3.1 文学部

请求地址： POST /user/{uid}/collection/1
请求参数：

字段	说明	类型	是否必须	备注
uid	用户id	number	是
page	页数	number	是

返回参数

字段	说明	类型	备注
code	状态码	number
message	错误信息	String
data	数据	json	按收藏时间倒序

data

字段	说明	类型	备注
cover	封面	String
title	主题	String
author	作者	String
digest	摘要	String
likeNum	点赞数	number
collectNum	收藏数	number
CollectTime	收藏时间	datetime	不足1小时，按1小时算

3.2 影像部

请求地址： POST /user/{uid}/collection/2
请求参数：

字段	说明	类型	是否必须	备注
uid	用户id	number	是
page	页数	number	是

返回参数：

字段	说明	类型	备注
code	状态码	number
message	错误信息	String
data	数据	json	按收藏时间倒序

data （ @）

字段	说明	类型	备注
authorPic	作者头像	String
author	作者	String
likeNum	点赞数	number
collectNum	收藏数	number
digest	摘要	String
coverUrl	封面图	String
lasted	视频时长	String	视频时长在视频上传后审核时获取
title	文章标题	String
collectTime	收藏时间	datetime	不足1小时，按1小时算
videoUrl	视频链接	String

4. 账号绑定

4.1 账号绑定详情页

请求地址： GET /user/{uid}/bind
请求参数：

字段	说明	类型	是否必须	备注
uid	用户id	number	是

返回参数：

字段	说明	类型	备注
code	状态码	number
message	错误信息	String
data	数据	json

data

字段	说明	类型	备注
phone	手机号	number
email	邮箱	String

4.2 绑定手机

4.2.1 手机绑定页面

请求地址： GET /user/{uid}/phone
请求参数：

字段	说明	类型	是否必须	备注
uid	用户id	number	是

返回参数：

字段	说明	类型	备注
code	状态码	number
message	错误信息	String

4.2.2 发送验证码

请求地址： POST /user/{uid}/phone/1
请求参数:

字段	说明	类型	是否必须	备注
uid	用户id	Number	是
phone	手机号	number	是

返回参数：

字段	说明	类型	备注
code	状态码	number
message	错误信息	String

4.2.3 绑定

请求地址： POST /user/{uid}/phone
请求参数：

字段	说明	类型	是否必须	备注
uid	用户id	Number	是
smsCode	短信验证码	number	是

返回参数：

字段	说明	类型	备注
code	状态码	number
message	错误信息	String
data	数据	json

data

字段	说明	类型	备注
state	绑定状态	boolean
getScore	获得的逆袭豆	number

4.3 绑定邮箱

4.3.1 邮箱绑定页面

请求地址： GET /user/{uid}/emial
请求参数：

字段	说明	类型	是否必须	备注
uid	用户id	number	是

返回参数：

字段	说明	类型	备注
code	状态码	number
message	错误信息	String

4.3.2 发送验证码

请求地址： POST /user/{uid}/email/1
请求参数:

字段	说明	类型	是否必须	备注
uid	用户id	Number	是
email	邮箱	String	是

返回参数：

字段	说明	类型	备注
code	状态码	number
message	错误信息	String

4.3.3 绑定

请求地址： POST /user/{uid}/email
请求参数：

字段	说明	类型	是否必须	备注
uid	用户id	Number	是
emailCode	邮箱验证码	number	是

返回参数：

字段	说明	类型	备注
code	状态码	number
message	错误信息	String
data	数据	json

data

字段	说明	类型	备注
state	绑定状态	boolean
getScore	获得的逆袭豆	number

5. 前台文学部

5.1 文学部列表页

请求地址： POST /api/banner/list
请求参数：

字段	说明	类型	是否必须	备注
type	类型	number	是	1：文章；2：视频

返回参数

字段	说明	类型	备注
code	状态码	number
message	错误信息	String
data	数据	json

data

字段	说明	类型	备注
title	banner标题	String
image	图片	String
redirectType	跳转类型	1：文章；2：视频
redirectAddr	跳转地址	String

5.1.2 card 文章

请求地址： POST /api/article/list
请求参数：

字段	说明	类型	是否必须	备注
page	页数	number	否	用户下拉

返回参数

字段	说明	类型	备注
code	状态码	number
message	错误信息	String
data	数据	json	按文章更新时间倒序

data

字段	说明	类型	备注
aid	文章id	number
cover	封面	String
title	主题	String
author	作者	String
digest	摘要	String
likeNum	点赞数	number
collectNum	收藏数	number
CollectTime	收藏时间	datetime	不足1小时，按1小时

5.2 文学部详情页

请求地址： POST /api/article/{aid}
请求参数：

字段	说明	类型	是否必须	备注
aid	文章id	number	是

返回参数

字段	说明	类型	备注
code	状态码	number
message	错误信息	String
data	数据	json

data

字段	说明	类型	备注
aid	文章id	number
cover	封面	String
title	主题	String
author	作者	String
digest	摘要	String
likeNum	点赞数	number
collectNum	收藏数	number
updateAt	更新时间	datetime
likeState	点赞状态	boolean
collectState	收藏状态	boolean

5.2.1 文章点赞

请求地址： POST /api/article/{aid}/like
请求参数：

字段	说明	类型	是否必须	备注
aid	文章id	number	是

返回参数

字段	说明	类型	备注
code	状态码	number
message	错误信息	String

5.2.2 文章收藏

请求地址： POST /api/article/{aid}/collect
请求参数：

字段	说明	类型	是否必须	备注
aid	文章id	number	是

返回参数

字段	说明	类型	备注
code	状态码	number
message	错误信息	String

明日计划

完善接口文档

返回列表

现在开始，找个师兄带你入门

现在开始，找个师兄带你入门

评论

技能树 | IT修真院

关于我们｜联系我们｜合作公司

移动端下载

友情链接

短信验证码

微信公众平台

Copyright © 2015 北京葡萄藤信息技术有限公司 All Rights Reserved | 京ICP备15035574号-1