发表于： 2019-10-28 12:52:15
1 1014
今天完成的事情：
接口文档的编写
1.输入搜索
通过输入作品ID或作品名称(可以是部分名称)获取具体作品
请求URL：
/task/works/search
请求方式：
GET
请求参数：
| 字段 | 类型 | 备注 | 是否必填 |
| work_id | Number | 需要查找的作品id | 是 |
| work_name | String | 需要查找的作品名称 | 是 |
返回参数：
| 字段 | 类型 | 备注 | 是否必填 |
| code | Number | 状态码 | 是 |
| message | String | 消息 | 是 |
| data | array | 数据息 | 是 |
data：
| 字段 | 类型 | 备注 | 是否必填 |
| works_id | Number | 作品的id值，每个id固定一个作品 | 是 |
| works_name | String | 作品名称 | 是 |
| works_url | String | 作品(图片)的链接 | 是 |
| works_video | String | 视频链接 | 是 |
| workshop | String | 作品所属工作室 | 是 |
| works_introduce | String | 作品介绍 | 是 |
| works_status | Number | 作品上下架状态，1代表上架，0代表下架 | 是 |
| first_id | Number | 所属一级导航栏 | 是 |
| second_id | Number | 所属二级导航栏 | 是 |
2.一级导航栏
点击一级导航栏上的按钮，从二级导航栏表中返回对应信息
请求URL：
/task/first
请求方式：
GET
请求参数：
| 字段 | 类型 | 备注 | 是否必填 |
| first_id | Number | 一级导航栏的id | 是 |
返回参数：
| 字段 | 类型 | 备注 | 是否必填 |
| code | Number | 状态码 | 是 |
| message | String | 消息 | 是 |
| data | array | 数据息 | 是 |
data：
| 字段 | 类型 | 备注 | 是否必填 |
| first_id | Number | 一级导航栏的id | 是 |
| second_id | Number | 二级导航栏的id | 是 |
| second_name | String | 二级导航栏标题内容 | 是 |
| 字段 | 类型 | 备注 | 是否必填 |
| second_id | Number | 需要查找的作品id | 是 |
返回参数：
| 字段 | 类型 | 备注 | 是否必填 |
| code | Number | 状态码 | 是 |
| message | String | 消息 | 是 |
| data | array | 数据息 | 是 |
data：
| 字段 | 类型 | 备注 | 是否必填 |
| second_id | Number | 需要查找的作品id | 是 |
| works_id | Number | 作品的id值，每个id固定一个作品 | 是 |
| works_name | String | 作品名称 | 是 |
| works_url | String | 作品(图片)的链接 | 是 |
| works_video | String | 视频链接 | 是 |
| workshop | String | 作品所属工作室 | 是 |
| works_introduce | String | 作品介绍 | 是 |
| works_status | Number | 作品上下架状态，1代表上架，0代表下架 | 是 |
| first_id | Number | 所属一级导航栏 | 是 |
| second_id | Number | 所属二级导航栏 | 是 |
4.banner图
从数据库中返回需要的banner图的链接
请求URL:
/task/banner/{banner_id}
请求方法：
GET
请求参数：
| 字段 | 类型 | 备注 | 是否必填 |
| banner_id | Number | 界面上需要展示的banner图的id | 是 |
返回参数：
| 字段 | 类型 | 备注 | 是否必填 |
| code | Number | 状态码 | 是 |
| message | String | 消息 | 是 |
| data | array | 数据息 | 是 |
data：
| 字段 | 类型 | 备注 | 是否必填 |
| banner_id | Number | 方便确认轮播图 | 是 |
| banner_url | String | 对应作品跳转的链接 | 是 |
| banner_img | String | 对应封面作品的链接 | 是 |
5.作品展示
点击作品，返回作品的信息，跟查询返回的作品信息相同
请求URL：
/task/show
请求方法：
GET
请求参数：
| 字段 | 类型 | 备注 | 是否必填 |
| work_id | Number | 需要查找的作品id | 是 |
返回参数：
| 字段 | 类型 | 备注 | 是否必填 |
| code | Number | 状态码 | 是 |
| message | String | 消息 | 是 |
| data | array | 数据息 | 是 |
data：
| 字段 | 类型 | 备注 | 是否必填 |
| works_id | Number | 作品的id值，每个id固定一个作品 | 是 |
| works_name | String | 作品名称 | 是 |
| works_url | String | 作品(图片)的链接 | 是 |
| works_video | String | 视频链接 | 是 |
| workshop | String | 作品所属工作室 | 是 |
| works_introduce | String | 作品介绍 | 是 |
| works_status | Number | 作品上下架状态，1代表上架，0代表下架 | 是 |
| first_id | Number | 所属一级导航栏 | 是 |
| second_id | Number | 所属二级导航栏 | 是 |
6.游客留言表
通过不同作品序号，返回对应的留言内容
请求URL：
/comments/tourists/
请求方式：
GET
请求参数：
| 字段 | 类型 | 备注 | 是否必填 |
| work_id | Number | 被评论的作品id | 是 |
返回参数：
| 字段 | 类型 | 备注 | 是否必填 |
| code | Number | 状态码 | 是 |
| message | String | 消息 | 是 |
| data | array | 数据息 | 是 |
data：
| 字段 | 类型 | 备注 | 是否必填 |
| tourist_id | Number | 游客的id | 是 |
| tourist_comment_id | Number | 留言的id | 是 |
| tourist_comment | String | 留言的内容 | 是 |
| works_id | Number | 对哪个作品进行评论 | 是 |
7.作者回复表
作者对游客评论的回复
请求URL:
/comments/author/
请求方法：
GET
请求参数：
| 字段 | 类型 | 备注 | 是否必填 |
| tourist_comment_id | Number | 留言的id | 是 |
返回参数：
| 字段 | 类型 | 备注 | 是否必填 |
| code | Number | 状态码 | 是 |
| message | String | 消息 | 是 |
| data | array | 数据息 | 是 |
data：
| 字段 | 类型 | 备注 | 是否必填 |
| tourist_id | Number | 游客的id | 是 |
| tourist_comment | String | 留言的内容 | 是 |
| author_id | Number | 回复的作者的id | 是 |
| author_name | String | 作者名 | 是 |
| author_comment | String | 回复的具体内容 | 是 |
8.关于作者和工作室
导航栏三个按钮对应的页面
请求URL:
/workshop/author
请求方法：
GET
请求参数：
| 字段 | 类型 | 备注 | 是否必填 |
| workshop_id | Number | 选择导航栏的哪个功能 | 是 |
返回参数：
| 字段 | 类型 | 备注 | 是否必填 |
| code | Number | 状态码 | 是 |
| message | String | 消息 | 是 |
| data | array | 数据息 | 是 |
data：
| 字段 | 类型 | 备注 | 是否必填 |
| workshop_id | Number | 选择导航栏的哪个功能 | 是 |
| workshop_img | String | 功能下需要的图片链接 | 是 |
| workshop_video | String | 功能下需要的视频链接 | 是 |
| worksop_text | String | 功能下需要的文本 | 是 |
明天计划的事情：学习利用mybatis-generator生成代码，写好假数据
遇到的问题：无
收获：学会编写接口文档
返回列表
评论