API设计

秒杀系统API接口设计

1 前言

1.1 编写目的

该项目采用前后端分离技术，API接口说明书可以明确划分系统功能，也为前后端整合，项目各模块测试提供了依据。

1.2

2.用户接口设计

一、登录

1、登录主页（/login/to_login）

Info	Value
接口	/login/to_login
地址	https://localhost:8080/login/to_login
功能	登录主页
验证	session
方法	DET/POST
数据	JSON

Response

参数名	类型	说明
login	String	登录的html页面

example

Code	Status
200	success
204	No Content
401	Unauthorized
403	Forbidden

2、登录(/login/do_login)

Info	Value
接口	/login/do_login
地址	https://localhost:8080/login/do_login
功能	判断登录信息
验证	session
方法	DET/POST
数据	JSON

Request

参数名	类型	说明
response	HttpServeletResponse	封装了向客户端发送数据、发送响应头，发送响应状态码的方法
loginVo	LoginVo	存储输入的手机号、密码
mobile	String	手机号
password	String	密码

Response

参数名	类型	说明
code	int	状态码
msg	String	提示信息
data	T	数据

example

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

4、QQ登录url(/getQQCode)

Info	Value
接口	/getQQCode
地址	https://localhost:8080/getQQCode
验证	Session
方法	DET/POST
数据	JSON

Request

参数名	类型	说明
model	Model	将数据返回前端界面

Response

参数名	类型	说明
login	String	登录界面
url	String	QQ登录的链接

example

Code	Status
200	success
204	No Content
401	Unauthorized
403	Forbidden

5、跳转QQ登录界面

Info	Value
接口	/QQCode
地址	https://localhost:8080/QQCode
验证	Session
方法	DET/POST
数据	JSON

Request

参数名	类型	说明
code	int	用户授权获得code

Response

参数名	类型	说明
userInfo	QQUserInfo	用户授权信息

example

Code	Status
200	success
204	No Content
401	Unauthorized
403	Forbidden

二、秒杀

1、商品列表（/goods/to_list）

Info	Value
接口	/goods/to_list
地址	https://localhost:8080/goods/to_list
验证	Session
方法	DET/POST
数据	JSON

Response

参数名	类型	说明
goodsList	String	商品信息展示的页面
goodsList	List	数据中存储的商品信息
user	Miaosha	用户信息

example

Code	Status
200	success
204	No Content
401	Unauthorized
403	Forbidden

2、商品详情（/goods/to_detail/）