发表于: 2019-10-28 23:48:18
1 1149
今天完成的事情:
写下接口文档
后台接口
表重新设计
study_object表
学习对象模块
学习对象模块数据库表设计
- 设计一个视频表与文章表,分开进行操作、将视频与文章抽象为学习对象,合成一个表进行操作。
- 统计方式,新建一个表专门做统计,将统计字段放到学习对象表中。
文章列表查询
接口:/a/list/study/article
请求方式:get
请求参数:
字段 | 说明 | 类型 | 是否必填 | 注释 |
---|---|---|---|---|
type | 学习对象类型 | Number | 是 | 要查文章传类型值为10 |
grade | 年级 | Number | 否 | 一年级:1、二年级:2(当前为写死) |
title | 标题 | String | 否 | 模糊查询 |
status | 状态 | Number | 否 | 上架:下架: |
endTime | 结束时间 | Number | 否 | 若需要进行日期区间搜索,起始时间与结束时间为必填 |
startTime | 起始时间 | Number | 否 | 若需要进行日期区间搜索,起始时间与结束时间为必填 |
返回参数:
字段 | 说明 | 类型 |
---|---|---|
code | 状态码 | Number |
message | 状态信息 | String |
data | json格式数据 | String |
data:
字段 | 说明 | 类型 |
---|---|---|
id | 序号 | Number |
title | 标题 | String |
createBy | 上传人(创建人) | String |
createAt | 发布时间(创建时间) | Number |
status | 上下架状态 | Number |
文章查看(详细查询)
接口:/a/study/article
请求方式:get
请求参数:
字段 | 说明 | 类型 | 是否必填 | 注释 |
---|---|---|---|---|
id | 序号 | Number | 是 | 序号 |
返回参数:
字段 | 说明 | 类型 |
---|---|---|
code | 状态码 | Number |
msg | 状态信息 | String |
data | json格式数据 | String |
data:
字段 | 说明 | 类型 |
---|---|---|
id | 序号 | Number |
cover | 封面 | String |
title | 标题 | String |
author | 作者(著作人) | String |
content | 文章内容 | String |
文章新增
接口:/a/study/article
请求方式:post
请求参数:
字段 | 说明 | 类型 | 是否必填 | 注释 |
---|---|---|---|---|
cover | 封面 | String | 是 | 封面图片小于…… |
title | 标题 | String | 是 | 小于20汉字,40字符 |
grade | 归属(年级) | Number | 否 | 年级由1起始,对应一年级 |
author | 作者(著作人) | String | 是 | 文章作者 |
content | 文章内容 | String | 是 |
返回参数
字段 | 说明 | 类型 |
---|---|---|
code | 状态码 | Number |
msg | 状态信息 | String |
id | 新增数据id | Number |
文章删除
接口:/a/study/article
请求方式:delect
请求参数:
字段 | 说明 | 类型 | 是否必填 | 注释 |
---|---|---|---|---|
id | 序号 | Number | 是 | 序号 |
返回参数
字段 | 说明 | 类型 |
---|---|---|
code | 状态码 | Number |
msg | 状态信息 | String |
文章修改
接口:/a/study/article
请求方式:put
请求参数:
字段 | 说明 | 类型 | 是否必填 | 注释 |
---|---|---|---|---|
id | 序号 | Number | 是 | |
cover | 封面 | String | 是 | 封面图片小于…… |
title | 标题 | String | 是 | 40字符(20汉字) |
grade | 归属(年级) | Number | 否 | 年级由1起始,对应一年级 |
author | 作者(著作人) | String | 是 | 文章作者 |
content | 文章内容 | String | 是 |
返回参数
字段 | 说明 | 类型 |
---|---|---|
code | 状态码 | Number |
msg | 状态信息 | String |
文章上下架
接口:/a/study/article/status
请求方式:put
请求参数:
字段 | 说明 | 类型 | 是否必填 | 注释 |
---|---|---|---|---|
id | 序号 | Number | 是 | |
status | 上下架 | Number | 是 |
返回参数:同文章修改
课程列表查询
接口:/a/list/study/video
请求方式:get
请求参数:
字段 | 说明 | 类型 | 是否必填 | 注释 |
---|---|---|---|---|
type | 学习对象类型 | Number | 是 | 要查课程传类型值为20 |
title | 标题 | String | 否 | 模糊查询 |
status | 状态 | Number | 否 | 上架:下架: |
grade | 年级 | Number | 否 | 一年级:1 / 二年级:2 / 三年级:3 …………(当前为写死) |
startTime | 起始时间 | Number | 否 | 若要进行日期区间搜索,起始时间与结束时间为必填 |
endTime | 结束时间 | Number | 否 | 若要进行日期区间搜索,起始时间与结束时间为必填 |
lowestPrice | 最低价 | Number | 否 | 若要进行价格区间搜索,最低价为必填 |
highestPrice | 最高价 | Number | 否 | 若要进行价格敬意搜索,最高价为必填 |
author | 老师姓名(著作人) | String | 否 | 文章表里为文章作者,课程表里为老师姓名,数据库统一为(suthor著作人/作者) |
返回参数:同文章查询
data:
字段 | 说明 | 类型 |
---|---|---|
id | 序号 | Number |
title | 标题 | String |
price | 原价(价格) | Number |
discount | 折扣价 | Number |
createAt | 上传时间(创建时间) | Number |
author | 老师(著作人) | String |
status | 上下架状态 | Number |
课程查看(详细查询)
接口:/a/study/video
请求方式:get
请求参数:同文章查询
返回参数:同文章查询
data:
字段 | 说明 | 类型 |
---|---|---|
id | 序号 | Number |
cover | 封面 | String |
title | 标题 | String |
video | 课程视频 | String |
grade | 课程归属(年级) | Number |
course | 课程归属(课程类型) | Number |
price | 价格 | Number |
discount | 折扣价 | Number |
intr | 课程简介 | String |
difficulty | 学习难点 | String |
studyTarget | 学习目标 | String |
author | 教课老师(著作人) | String |
authorTitle | 相关称号(著作人称号) | String |
authorIntr | 老师简介(著作人简介) | String |
课程新增
接口:/a/study/video
请求方式:post
请求参数:
字段 | 说明 | 类型 | 是否必填 | 注释 |
---|---|---|---|---|
cover | 封面 | String | 否 | |
title | 标题 | String | 是 | 小于20汉字,40字符 |
video | 课程视频 | String | 是 | |
grade | 课程归属(年级) | Number | 否 | |
course | 课程归属(课程类型) | Number | 否 | |
price | 价格 | Number | 否 | |
discount | 折扣价 | Number | 否 | |
intr | 课程简介 | String | 否 | 小于200 |
difficulty | 学习难点 | String | 否 | 小于200 |
studyTarget | 学习目标 | String | 否 | 小于100 |
author | 教课老师(著作人) | String | 否 | 小于10汉字,20字符 |
authorTitle | 相关称号(著作人称号) | String | 否 | 小于10汉字,20字符 |
authorIntr | 老师简介(著作人简介) | String | 否 |
返回参数:同文章新增
课程删除
接口:/a/study/video
请求方式:delect
请求参数:同文章删除
返回参数:同文章删除
课程修改
接口:/a/study/video
请求方式:put
请求参数:
字段 | 说明 | 类型 | 是否必填 | 注释 |
---|---|---|---|---|
字段 | 说明 | 类型 | 是否必填 | 注释 |
id | 序号 | Number | 是 | |
cover | 封面 | String | 否 | |
title | 标题 | String | 是 | 小于20汉字,40字符 |
video | 课程视频 | String | 是 | |
grade | 课程归属(年级) | Number | 否 | |
course | 课程归属(课程类型) | Number | 否 | |
price | 价格 | Number | 否 | |
discount | 折扣价 | Number | 否 | |
intr | 课程简介 | String | 否 | 小于200 |
difficulty | 学习难点 | String | 否 | 小于200 |
studyTarget | 学习目标 | String | 否 | 小于100 |
author | 教课老师(著作人) | String | 否 | 小于10汉字,20字符 |
authorTitle | 相关称号(著作人称号) | String | 否 | 小于10汉字,20字符 |
authorIntr | 老师简介(著作人简介) | String | 否 |
返回参数:同文章新增
课程上下架
接口:/a/study/video/status
请求方式:put
请求参数:同文章上下架
返回参数:同文章修改
明天计划的事情:
订单接口
遇到的问题:
麻烦的还是几个表间的关联
收获:
评论