秒杀API接口文档

swagger是什么：

Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。简单来说，Swagger是一个功能强大的接口管理工具，并且提供了多种编程语言的前后端分离解决方案。
·Swagger可以整合到代码中，在开发时通过注解，编写注释，自动生成API文档；
·方便前后端分离开发

1.Swagger接口生成工作原理

（1）、系统启动，扫描到api工程中的Swagger2Configuration类
（2）、在此类中指定了包路径com.xuecheng，找到在此包下及子包下标记有@RestController注解的controller类
（3）、根据controller类中的Swagger注解生成接口文档。

2.参数列表

code	Reason
201	资源创建成功
204	成功处理请求
400	请求失败，具体返回业务状态码与对应消息
401	请求失败未经身份认可
405	请求方法不支持
500	无法处理的请求

2.1用户接口

接口：/goods/ to_list

表2-1 登录Request参数：

参数	类型	是否可为空	描述
mobile	int	否	手机号
password	String	否	密码
verifyInput	String	否	验证码
nickname	String	是	用户昵称
lastLoginDate	date	是	最后登录时间
registerDate	date	是	注册时间

表2-2登录Response参数：

参数	类型	是否可为空	描述
code	int	否	状态码
msg	String	否	返回信息
data	boolean	否	是否登录成功

3.商品接口

接口：接口：/goods/to_detail/{goodsId}

表3-1 商品Request参数

参数名	类型	是否可为空	描述
goodsID	int	否	商品ID

表3-2 商品Response参数

参数名	类型	是否可为空	描述
goodsname	String	否	商品名称
goodsID	long	否	商品ID
goodsprice	double	否	秒杀价格
miaoshatime	int	否	秒杀倒计时
goodsImg	String	否	商品照片

4.秒杀接口

接口：/miaosha/ do_miaosha

表4-1 商品详情Request参数

参数名	类型	是否可为空	描述
goodsID	long	否	商品ID

表4-2Response参数

参数名	参数类型	是否可为空	描述
goodsname	String	否	商品名称
goodsID	int	否	商品ID
goodsPrice	Doouble	否	商品价格
orderDate	Date	否	下单时间
orderStatus	Integer	否	订单状态