发表于： 2017-10-14 23:21:03
1 683
【今日完成】
今天完成了后台的接口文档。
《学渣乐园后台接口文档》
目录
一、用户管理
1、用户详情
前端：
后端：
请求地址：get /a/u/user/{id}
字段 | 说明 | 是否必填 | 类型 |
id | 用户id | 是 | String |
返回参数
字段 | 说明 | 类型 |
code | 状态码 | Int |
message | 消息 | string |
data | 数据 | object |
data
字段 | 说明 | 类型 |
nick | 昵称 | string |
grade | 年级 | int |
mobile | 手机 | string |
邮箱 | string | |
img | 头像 | string |
beans | 逆袭豆数量 | int |
2、冻结/解冻用户
前端：
后端：
请求地址：put /a/u/freeze/user/{id}
请求参数
字段 | 说明 | 类型 | 是否必填 | 备注 |
id | 用户id | String | 是 |
|
status | 状态 | int | 是 | 1：正常 2：冻结 |
返回参数
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
3、用户列表
前端：
后端：
请求地址：get /a/u/user/list
请求参数
字段 | 说明 | 类型 | 是否必填 | 备注 |
alias | 用户名称 | String | 否 |
|
status | 状态 | int | 否 | 1：正常 2：冻结 |
grade | 年级 | int | 否 | 1:全部 2:初一 3:初二 4:初三 5:高一 6:高二 7:高三 |
邮箱 | string | 否 |
| |
mobile | 手机号 | string | 否 |
|
beanStart | 豆子起点 | int | 否 |
|
beanEnd | 豆子终点 | int | 否 |
|
location | 所在区域 | string | 否 |
|
page | 页数 | int | 是 |
|
size | 页长 | int | 是 | 存疑：不该是固定的么？ |
返回参数
字段 | 说明 | 类型 |
code | 状态码 | int |
message | 消息 | string |
data |
| object |
total | 用户总数 | int |
data
字段 | 说明 | 类型 |
list |
| Array |
list的object：
字段 | 说明 | 类型 | 备注 |
id | 用户id | Long |
|
alias | 用户名 | string |
|
邮箱 | string |
| |
mobile | 手机号 | string |
|
bean | 逆袭豆 | int |
|
grade | 年级 | int |
|
location | 区域 | string |
|
status | 状态 | int |
|
二、文档管理
1、新增文档
前端：
后端：
请求地址：post /a/u/document
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
title | 名称 | string | 是 |
|
author | 作者 | String | 是 |
|
type | 类型 | int | 是 | 文章有无banner？ |
coverImg | 封面 | String | 是 |
|
content | 正文 | String | 是 |
|
summary | 摘要 | String | 是 |
|
返回参数
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
2、编辑文档
前端：
后端：
请求地址：put /a/u/document/{id}
字段 | 说明 | 类型 | 是否必填 | 备注 |
id | 文章id | string | 是 |
|
title | 名称 | string | 是 |
|
author | 作者 | String | 是 |
|
type | 类型 | int | 是 | 文章有无banner？ |
coverImg | 图片 | String | 是 |
|
content | 正文 | String | 是 |
|
summary | 摘要 | String | 是 |
|
返回参数
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
3、文档上下架
前端：
后端：
请求地址：put /a/u/document/{id}/status
字段 | 说明 | 类型 | 是否必填 | 备注 |
id | 文章id | string | 是 | hidden |
status | 状态 | Int | 是 | 1：上架 2：下架 |
返回参数
字段 | 说明 | 类 型 |
code | 状态码 | number |
message | 消息 | string |
4、文档详情
前端：
后端：
请求地址：get /a/u/document/{id}
请求参数
字段 | 说明 | 是否必填 | 类型 |
id | 文档id | 是 | String |
返回参数
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
data | 数据 | array |
data：
字段 | 说明 | 类型 | 是否必填 | 备注 |
title | 名称 | string | 是 |
|
author | 作者 | String | 是 |
|
type | 类型 | Int | 是 | ？ |
coverImg | 图片 | String | 是 |
|
content | 正文 | String | 是 |
|
summary | 摘要 | String | 是 |
|
5、文档列表
前端：
后端：
请求地址：get /a/u/document/list
请求参数
字段 | 说明 | 类型 | 是否必填 | 备注 |
type | 类型 | int | 否 | ? |
author | 作者 | string | 否 |
|
title | 标题 | String | 否 |
|
status | 状态 | int | 否 | 1：上架 2：下架 |
likeStart | 点赞最小值 | Int | 否 |
|
likeEnd | 点赞最大值 | Int | 否 |
|
collectStart | 收藏最小值 | Int | 否 |
|
collectEnd | 收藏最大值 | int | 否 |
|
返回参数
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
data | 数据 | array |
data：
字段 | 说明 | 类型 | 备注 |
title | 名称 | string |
|
status | 状态 | Int | 1、下架 2、上架 |
author | 作者 | string |
|
type | 类型 | Int |
|
img | 图片 | String |
|
content | 说明 | String |
|
summary | 摘要 | String |
|
like | 点赞 | Int |
|
collection | 收藏 | Int |
|
7、保存文档banner排序（拖拽功能）
前端：
后端：培宇-完成
请求地址：post /a/u/document/sort
请求参数：Application/json 方式
类型：array
示例 [2,3,4,5]
返回参数：
字段 | 说明 | 类型 | 备注 |
code | 错误代码 | number |
|
message | 说明信息 |
|
|
三、视频管理
1、新增视频
前端：
后端：
请求地址：post /a/u/video
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
title | 名称 | string | 是 |
|
coverImg | 封面图 | String | 否 | banner必填 |
cutImg | 视频截图 | String | 是 |
|
type | 类型 | number | 是 |
|
coverImg | 图片 | String | 是 |
|
content | 正文 | String | 是 |
|
summary | 摘要 | String | 是 |
|
grade | 年级 | number | 是 |
|
subject | 科目 | number | 是 |
|
teacherName | 教师名称 | String | 是 |
|
teacherImg | 教师头像 | String | 是 |
|
url | 视频链接 | String | 是 |
|
duration | 视频时长 | String | 是 |
|
返回参数
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
2、新增教师
前端：
后端：
请求地址：post /a/u/teacher
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
name | 教师名称 | String | 是 |
|
photo | 教师头像 | String | 是 |
|
返回参数
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
3、删除教师
前端：
后端：
请求地址：delete /a/u/teacher/{id}
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
id | 教师ID | String | 是 | 在uri上传参 |
返回参数
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
4、编辑视频
前端：
后端：
请求地址：put /a/u/video/{id}
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
grade | 年级 | number | 是 |
|
subject | 科目 | String | 是 |
|
tid | 教师id | number | 是 |
|
title | 标题 | String | 是 |
|
type | 视频类型 | number | 是 | 1、banner 2、普通 |
coverImg | 封面图 | string | 是 |
|
cutImg | 视频截图 | string | 否 | ? |
content | 正文 | string | 是 |
|
summary | 简介 | string | 是 |
|
duration | 视频时长 | string | 是 | ? |
返回参数
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
5、视频上下架
前端：
后端：
请求地址：put /a/u/video/{aid}/status
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
id | 视频id | string | 是 | hidden |
status | 状态 | Int | 是 | 1：上架 2：下架 |
返回参数
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
6、视频详情
前端：
后端：
请求地址：get /a/u/video/{id}
请求参数
字段 | 说明 | 是否必填 | 类型 |
id | 用户id | 是 | String |
返回参数
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
data | 数据 | array |
data：
字段 | 说明 | 类型 | 备注 |
title | 名称 | string |
|
coverImg | 封面图 | String | banner必填 |
cutImg | 视频截图 | String |
|
type | 类型 | number |
|
coverImg | 图片 | String |
|
content | 正文 | String |
|
summary | 摘要 | String |
|
grade | 年级 | number |
|
subject | 科目 | number |
|
teacherName | 教师名称 | String |
|
teacherImg | 教师头像 | String |
|
url | 视频链接 | String |
|
collection | 收藏数 | number |
|
like | 点赞数 | number |
|
status | 状态 | number |
|
updateBy | 编辑时间 | number |
|
duration | 视频时长 | string |
|
7、视频列表
前端：
后端：
请求地址：get /a/video/list
请求参数
字段 | 说明 | 类型 | 是否必填 | 备注 |
type | 类型 | Int | 否 |
|
grade | 年级 | int | 否 |
|
title | 标题 | String | 否 |
|
status | 状态 | int | 否 |
|
subject | 科目 | int | 否 |
|
minLike | 点赞书范围下限 | Long | 否 |
|
maxLike | 点赞数范围上限 | Long | 否 |
|
minCollection | 收藏数范围下限 | Long | 否 |
|
maxCollection | 收藏数范围上限 | Long | 否 |
|
teacherName | 教师名称 | string | 否 |
|
返回参数
字段 | 说明 | 类型 |
code | 状态码 | number |
message | 消息 | string |
data | 数据 | array |
data：
字段 | 说明 | 类型 | 备注 |
title | 名称 | string |
|
coverImg | 封面图 | String | banner必填 |
cutImg | 视频截图 | String |
|
type | 类型 | number |
|
coverImg | 图片 | String |
|
content | 正文 | String |
|
summary | 摘要 | String |
|
grade | 年级 | number |
|
subject | 科目 | number |
|
teacherName | 教师名称 | String |
|
teacherImg | 教师头像 | String |
|
url | 视频链接 | String |
|
collection | 收藏数 | number |
|
love | 点赞数 | number |
|
status | 状态 | number |
|
updateBy | 编辑时间 | number |
|
duration | 视频时长 | number |
|
7、保存视频banner排序（拖拽功能）
前端：
后端：培宇-完成
请求地址：post /a/u/video/sort
请求参数：Application/json 方式
类型：array
示例 [2,3,4,5]
返回参数：
字段 | 说明 | 类型 | 备注 |
code | 错误代码 | number |
|
message | 说明信息 |
|
|
红色表示不确定，绿色表示应该不需要
【今日收获】
学习了写接口文档
返回列表
评论