发表于： 2019-10-30 22:58:47
1 976
今天完成的事情：
作为一个开发一定要习惯PM改需求，增加需求什么的。
有些请求，返回参数是固定的，就把他单独列出来，剩的一真写，有特殊的把他补上就好
详细查询请求参数：
字段 | 说明 | 类型 | 是否必填 | 注释 |
|---|---|---|---|---|
| id | XX序号 | Number | 是 |
列表查询请求参数：默认包含页数与行数
字段 | 说明 | 类型 | 是否必填 | 注释 |
|---|---|---|---|---|
| page | 页数 | Number | 否 | 默认第一页 |
| size | 行数（每页记录数） | Number | 否 | 默认十条数据 |
详细查询与列表查询返回参数：
字段 | 说明 | 类型 |
|---|---|---|
code | 状态码 | Number |
message | 状态信息 | String |
data | json格式数据 | String |
删除请求参数：
字段 | 说明 | 类型 | 是否必填 | 注释 |
|---|---|---|---|---|
| id | XX序号 | Number | 是 |
删除与修改返回参数：
字段 | 说明 | 类型 |
|---|---|---|
code | 状态码 | Number |
message | 状态信息 | String |
增加返回参数：
字段 | 说明 | 类型 |
|---|---|---|
code | 状态码 | Number |
message | 状态信息 | String |
| id | 新增数据id |
之前文章和视频是分开弄接口，后面想了想，反正都是一个表里的，就一个接口解决了，前端传类型来区分就好了。
学习对象列表查询
接口：/a/u/list/study
请求方式：get
字段 | 说明 | 类型 | 是否必填 | 注释 |
|---|---|---|---|---|
| type | 学习对象类型 | Number | 是 | 文章：10 /视频：20 |
| title | 标题 | String | 否 | 模糊查询 |
| status | 状态 | Number | 否 | 上架：1 /下架：0 |
| grade | 年级 | Number | 否 | 初一：11、高一：21 |
| startTime | 起始时间 | Number | 否 | 若需要进行日期区间搜索，起始时间与结束时间为必填 |
| endTime | 结束时间 | Number | 否 | 若需要进行日期区间搜索，起始时间与结束时间为必填 |
| lowestPrice | 最低价 | Number | 否 | 若要进行价格区间搜索，最低价为必填 |
| highestPrice | 最高价 | Number | 否 | 若要进行价格敬意搜索，最高价为必填 |
| author | 老师姓名（著作人） | String | 否 | 文章表里为文章作者，课程表里为老师姓名，数据库统一为（suthor著作人/作者） |
返回参数：同通用样例
data:
字段 | 说明 | 类型 |
|---|---|---|
| id | 序号 | Number |
| title | 标题 | String |
| createBy | 上传人（创建人） | String |
| createAt | 发布时间（创建时间） | Number |
| status | 上下架状态 | Number |
| price | 原价（价格） | Number |
| discount | 折扣价 | Number |
| author | 老师（著作人） | String |
学习对象详细查询
接口：/a/u/study
请求方式：get
请求参数：同通用样例
返回参数：同通用样例
data:
字段 | 说明 | 类型 |
|---|---|---|
| id | 序号 | Number |
| cover | 封面 | String |
| title | 标题 | String |
| author | 作者,教课老师（著作人） | String |
| content | 文章内容 | String |
| video | 课程视频 | String |
| grade | 课程归属（年级） | Number |
| course | 课程归属（课程类型） | Number |
| price | 价格 | Number |
| discount | 折扣价 | Number |
| intr | 课程简介 | String |
| difficulty | 学习难点 | String |
| studyTarget | 学习目标 | String |
| avatar | 头像 | String |
| authorTitle | 相关称号（著作人称号） | String |
| authorIntr | 老师简介（著作人简介） | String |
学习对象增加
接口：/a/u/study
请求方式：post
请求参数：
字段 | 说明 | 类型 | 是否必填 | 注释 |
|---|---|---|---|---|
| cover | 封面 | String | 是 | 封面图片小于…… |
| title | 标题 | String | 是 | 小于20汉字，40字符 |
| grade | 归属（年级） | Number | 否 | 年级由1起始，对应一年级 |
| author | 作者,教课老师（著作人） | String | 是 | 文章作者 |
| content | 文章内容 | String | 是 | |
| video | 课程视频 | String | 是 | |
| course | 课程归属（课程类型） | Number | 否 | |
| price | 原价（价格） | Number | 否 | |
| discount | 折扣价 | Number | 否 | |
| intr | 课程简介 | String | 否 | 小于200 |
| difficulty | 学习难点 | String | 否 | 小于200 |
| studyTarget | 学习目标 | String | 否 | 小于100 |
| avatar | 头像 | String | 否 | 不大于5M |
| authorTitle | 相关称号（著作人称号） | String | 否 | 小于10汉字，20字符 |
| authorIntr | 老师简介（著作人简介） | String | 否 |
返回参数：同通用样例
学习对象删除
接口：/a/u/study
请求方式：delect
请求参数：同通用样例
返回参数：同通用样例
学习对象修改
接口：/a/u/study
请求方式：put
请求参数：
字段 | 说明 | 类型 | 是否必填 | 注释 |
|---|---|---|---|---|
| id | 序号 | Number | 是 | |
| cover | 封面 | String | 是 | 封面图片小于…… |
| title | 标题 | String | 是 | 小于20汉字，40字符 |
| grade | 归属（年级） | Number | 否 | 年级由1起始，对应一年级 |
| author | 作者,教课老师（著作人） | String | 是 | 文章作者 |
| content | 文章内容 | String | 是 | |
| video | 课程视频 | String | 是 | |
| course | 课程归属（课程类型） | Number | 否 | |
| price | 原价（价格） | Number | 否 | |
| discount | 折扣价 | Number | 否 | |
| intr | 课程简介 | String | 否 | 小于200 |
| difficulty | 学习难点 | String | 否 | 小于200 |
| studyTarget | 学习目标 | String | 否 | 小于100 |
| avatar | 头像 | String | 否 | 不大于5M |
| authorTitle | 相关称号（著作人称号） | String | 否 | 小于10汉字，20字符 |
| authorIntr | 老师简介（著作人简介） | String | 否 |
返回参数：同通用样例
学习对象上下架
接口：/a/u/study
请求方式：put
请求参数：
字段 | 说明 | 类型 | 是否必填 | 注释 |
|---|---|---|---|---|
| id | 序号 | Number | 是 | |
| status | 上下架 | Number | 是 |
返回参数：同文章修改
明天计划的事情：
把PM要改功能重新写接口和方案。
遇到的问题：
有些你决的好的做法，PM不认可，你能怎么办，，比如列表查询要请求文章里面的内容。明明标题就好了，或者弄介绍。
嗯，要不我只获取这个内容的开头一小段？应该是可以的。
收获：
返回列表
评论