发表于： 2020-08-05 23:58:17
1 1900
今天完成的事情：
1.编写接口文档
公告
请求地址：/u/notice
请求方式：GET
请求参数：
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String | |
| data | 返回对象 | Json |
data
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
id | bigint(20) | 主键id | |
title | varchar(20) | 标题 | |
content | varchar(255) | 公告内容 |
签到
获取当前积分
请求地址：/u/uscore/{uid}
请求方法：GET
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| uid | 用户id | Number | 是 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String | |
| uscore | 当前用户所拥有积分 | Number |
获取本月签到时间
请求地址：/u/sign/sign_date/{uid}
请求方法：GET
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| uid | 用户id | Number | 是 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String | |
| data | 签到日期 | Json | 当前用户本月签到记录 |
data
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| sign_date | 签到时间 | Number |
点击签到
请求地址：/u/sign/{uid}
请求方法：POST
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| uid | 用户id | Number | 是 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String |
获取连续签到天数
请求地址：/u/sign/sign_countMonth{uid}
请求方法：GET
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| uid | 用户id | Number | 是 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String | |
| sign_countMonth | 本月连续签到天数 | Number | |
| score | 增加积分 | Number |
消息
消息列表
请求地址：/u/news/{uid}
请求方式：GET
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| uid | 用户id | Number | 是 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String | |
| data | 消息 | Json |
data
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| title | 标题 | String | |
| content | 内容 | String | |
| url | 跳转链接 | String |
我的
个人信息
请求地址：/u/user/{uid}
请求方式：GET
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| uid | 用户id | Number | 是 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String | |
| data | 用户信息 | Json |
data
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| uname | 姓名 | String | |
| uphoto | 头像 | String | |
| ugender | 性别 | Number | |
| uphone | 手机 | String | |
| gid | 年级 | Number | 见约定 |
我的课程
请求地址：/u/course/{uid}
请求方式：GET
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| uid | 用户id | Number | 是 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String | |
| data | 课程 | Json |
data
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| id | 课程id | Number | |
| name | 课程名称 | String | |
| image | 封面 | String | |
| content | 课程内容 | String |
修改个人信息（姓名/头像/性别/年级）
请求地址：/u/user/{uid}
请求方式：PUT
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| uid | 用户id | Number | 是 | |
| uname | 姓名 | String | 否 | |
| uphoto | 头像 | String | 否 | |
| ugender | 性别 | Number | 否 | |
| gid | 年级 | Number | 否 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String |
绑定手机号
请求地址：/u/user/uphone/{id}
请求方式：POST
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| uphone | 手机号 | Number | 是 | |
| code | 验证码 | Number | 是 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String |
发送验证码
请求地址：/u/user/sendmsg
请求方式：POST
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| uphone | 手机号 | Number | 是 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String |
课程管理
支付
banner图
请求地址：/u/banner
请求方式：GET
请求参数：
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String | |
| data | banner图 | Json |
data
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| image | 封面 | String | |
| url | 指向链接 | String |
获取推荐课程
请求地址：/u/course/recommend
请求方式：GET
请求参数：
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String | |
| counts | 购买人数 | Number | |
| data | 课程 | Json |
data
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| name | 课程名称 | String | |
| image | 封面 | String | |
| price | 课程价格 | Number |
查询课程详情
请求地址：/u/course/{cid}
请求方式：GET
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| cid | 课程id | Number | 是 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String | |
| status | 收藏状态 | Number | 约定 |
| data | 课程 | Json |
data
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| name | 课程名称 | String | |
| video | 视频链接 | String | |
| createat | 创建时间 | Number | |
| price | 课程价格 | Number | |
| content | 课程详情 | String |
根据年级/学科查询课程
请求地址：/u/course
请求方式：GET
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| gid | 年级 | Number | 是 | |
| sid | 科目 | Number | 是 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String | |
| counts | 购买人数 | Number | |
| data | 课程 | Json |
data
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| name | 课程名称 | String | |
| image | 封面 | String | |
| price | 课程价格 | Number |
搜索课程
请求地址：/u/course/search
请求方式：GET
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| keyword | 关键字 | String | 是 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String | |
| counts | 购买人数 | Number | |
| data | 课程 | Json |
data
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| name | 课程名称 | String | |
| image | 封面 | String | |
| price | 课程价格 | Number |
后台
登录
请求地址：/login
请求方式：POST
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| name | 用户名 | String | 是 | |
| password | 密码 | String | 是 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String |
消息管理
查询所有消息
请求地址：/a/news
请求方式：GET
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| pagenow | 当前页数 | Number | 否 | |
| pagesize | 每页显示条数 | Number | 否 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String | |
| data | 消息 | Json |
data
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| id | 主键id | Number | |
| title | 消息标题 | String | |
| type | 推送方式 | Number | 约定 |
| time | 推送时间 | Number | |
| status | 状态 | Number | 约定 |
查询单条消息
请求地址：/a/news/{nid}
请求方式：GET
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| nid | 消息id | Number | 是 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String | |
| data | 消息 | Json |
data
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| id | 主键id | Number | |
| title | 消息标题 | String | |
| time | 推送时间 | Number | |
| url | 跳转url | String | |
| createat | 创建时间 | Number | |
| createby | 创建人 | String |
根据条件查询消息
请求地址：/a/news
请求方法：GET
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| title | 消息标题 | String | 否 | |
| status | 状态 | Number | 否 | |
| type | 推送方式 | Number | 否 | |
| time_start | 起始时间 | Number | 否 | |
| time_end | 终止时间 | Number | 否 | · |
| pagenow | 当前页数 | Number | 否 | |
| pagesize | 每页显示条数 | Number | 否 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String | |
| data | 消息 | Json |
data
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| id | 主键id | Number | |
| title | 消息标题 | String | |
| type | 推送方式 | Number | 约定 |
| time | 推送时间 | Number | |
| status | 状态 | Number | 约定 |
新增消息
请求地址：/a/news
请求方式：POST
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| title | 消息标题 | String | 是 | |
| content | 消息内容 | String | 是 | |
| url | 跳转url | String | 是 | |
| gid | 推送年级 | Number | 是 | 约定 |
| type | 推送方式 | Number | 是 | 约定 |
| time | 推送时间 | Number | 否 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String |
删除消息
请求地址：/a/news/{nid}
请求方式：DELETE
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| nid | 消息id | Number | 是 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String |
修改消息推送方式
请求地址：/a/news/{nid}
请求方式：PUT
请求参数：
字段 | 说明 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| nid | 消息id | Number | 是 |
返回参数：
字段 | 说明 | 类型 | 备注 |
|---|---|---|---|
| code | 状态码 | Number | |
| message | 状态信息 | String |
返回列表
评论