秒杀API设计

一、登录

1.跳转登录界面（/login/to_login）
request

无

response

参数名	类型	是否必须	描述
login	String	Y	登录html页面

success

Status	body
200	login.html界面

fail

HTTP Status Code	Reason
204	No Content
401	Unauthorized
403	Forbidden

2.登录（/login/do_login）
request

参数名	类型	是否必须	描述
response	HttpServletResponse	Y	封装了向客户端发送数据、发送响应头，发送响应状态码的方法
loginVo	LoginVo	Y	存储前台输入手机号、密码的数据
mobile	String	Y	手机号
password	String	Y	密码

response

参数名	类型	是否必须	描述
code	int	Y	状态码
msg	String	Y	提示信息
data	T	Y	数据

success

code	msg	data
0	success	true

fail

code	msg	data
500213	参数校验异常：手机号码格式不正确	null
500215	密码错误	null

3.跳转到手机发送验证码登录界面(/login/mobile/)
Request

无

response

参数名	类型	是否必须	描述
mobile	String	Y	显示手机登录界面

success
success

Status	body
200	mobile.html界面

fail

HTTP Status Code	Reason
204	No Content
401	Unauthorized
403	Forbidden

4.跳转到阿里云发送短信登录界面(/login/do_authcode)
request

参数名	类型	是否必须	描述
response	HttpServletResponse	Y	封装了向客户端发送数据、发送响应头，发送响应状态码的方法
loginVo	LoginVo	Y	存储前台输入手机号、密码的数据
mobile	String	Y	手机号

response

参数名	类型	是否必须	描述
code	int	Y	状态码
msg	String	Y	提示信息
data	T	Y	数据

success

code	msg	data
0	success	true

fail

code	msg	data
500213	参数校验异常：手机号码格式不正确	null

5.跳转到短信验证码登录(/login/authcode_login)
request

参数名	类型	是否必须	描述
mobile	String	Y	手机号
password	String	Y	验证码

response

参数名	类型	是否必须	描述
code	int	Y	状态码
msg	String	Y	提示信息
data	T	Y	数据

success

Status	body
200	goods_list.html界面

fail

code	msg	data
500213	参数校验异常：手机号码格式不正确	null
500215	密码错误	null

二、QQ登录

1.获得跳转到qq登录页的url,前台直接连接访问(/getQQCode)
request

参数名	类型	是否必须	描述
mobile	Model	Y	将数据返回前端页面

response

参数名	类型	是否必须	描述
login	String	Y	登录界面
url	String	Y	QQ登录链接

success

Status	body
200	将url显示在login.html界面中

fail

HTTP Status Code	Reason
204	No Content
401	Unauthorized
403	Forbidden

2.进行QQ登录(/QQLogin)
request

参数名	类型	是否必须	描述
code	int	Y	用户授权获得code

response

参数名	类型	是否必须	描述
UserInfo	QQUserInfo	Y	用户授权信息

success

Status	body
200	goods_list.html信息

fail

HTTP Status Code	Reason
204	No Content
401	Unauthorized
403	Forbidden

三、秒杀

1.登录后可进行秒杀(/miaosha/do_miaosha)
request

参数名	类型	是否必须	描述
user	MiaoshaUser	Y	用户信息
goodId	Long	Y	商品编号
model	Model	Y	将数据返回前端

response

参数名	类型	是否必须	描述
order_detail	String	Y	订单秒杀详情界面
login	String	Y	用户登录界面
user	MiaoshaUser	Y	用户信息
orderInfo	OrderInfo	Y	秒杀订单信息
goods	GoodsVo	Y	商品信息
code	int	Y	状态码
msg	String	Y	提示信息
data	T	Y	数据

success

Status	body
200	order_detail.html信息

fail

code	msg	data
500500	商品已经秒杀完毕	null
500501	不能重复秒杀	null

四、商品访问

1.显示商品列表(/goods/to_list)
request

参数名	类型	是否必须	描述
user	MiaoshaUser	Y	用户信息
model	Model	Y	将数据返回前端

response

参数名	类型	是否必须	描述
goodsList	String	Y	商品信息展示
goodsList	List	Y	数据中存储的商品信息
user	MiaoshaUser	Y	用户信息

success

Status	body
200	goods_list.html信息

fail

HTTP Status Code	Reason
204	No Content
401	Unauthorized
403	Forbidden

2.显示商品详情(/goods/to_detail/)
request

参数名	类型	是否必须	描述
user	MiaoshaUser	Y	用户信息
model	Model	Y	将数据返回前端
goodsId	Long	Y	数据库中商品的编号

response

参数名	类型	是否必须	描述
goods_detail	String	Y	商品信息展示
miaoshaStatus	int	Y	秒杀的状态码
user	MiaoshaUser	Y	用户信息
remainSeconds	int	Y	秒杀时间
goods	GoodsVo	Y	根据id获取商品信息
code	int	Y	状态码
msg	String	Y	提示信息
data	T	Y	数据

success

Status	body
200	goods_details.html信息

fail

code	msg	data
5	服务端异常	null