秒杀商城API

1、背景

       接口文档，顾名思义就是对接口说明的文档。好的接口文档包含了对接口URL，参数以及输出内容的说明，我们参照接口文档就能编写出一个个的测试用例。而且接口文档详细的话，测试用例编写简单，不会遗漏。这里使用API文档对商城秒杀系统进行API接口设计的测试。

2、正文

        首先我们要设置秒杀商品的列表，将接口地址、描述等准备好。

2.1 response参数

参数名	类型	是否必要	描述
code	int	是	状态码
msg	String	是	返回提示
data	任意	否	返回信息

2.2 商品详情

request参数

变量名	含义	类型	备注
user	用户	int
id	商品名称	int

2.3登陆访问

接口名称	描述
/miaosha/do_miaosha	秒杀功能

 2.4 错误返回码详情

code	msg
500100	服务端异常
500101	参数校验异常：%s
500210	Session不存在或已经失效
500211	登录密码不能为空
500212	手机号不能为空
500213	手机号格式错误
500214	手机号不存在
500215	密码错误
500216	验证码为空
500217	验证码错误
500500	商品已经秒杀完毕
500501	不能重复秒杀

 2.5用户登录

接口：/login/do_login

描述：用户登录

校验：session

方法：get/post

 

参数名	类型	是否必须	描述
phone	String	是	手机号
password	String	是	密码
yzm	String	否	验证码
if	int	否	是否需要验证码

 用户需要登陆Response函数

参数名	类型	是否必要	描述
code	int	是	状态码
msg	String	是	返回提示
data	任意	否	返回信息

2.6 商品接口

接口：/goods/ to_list

描述：商品列表

校验：session

方法：get/post

Requst不需要传入参数，返回商品列表信息，通过Model 进行数据传递goodsList

接口：/goods/ to_list

描述：商品列表

校验：session

方法：get/post

Requst不需要传入参数，返回商品列表信息，通过Model 进行数据传递goodsList

 

参数名	类型	是否必须	描述
goodsList	List<GoodsVo>	是	商品列表信息
goods. Name	String	是	商品名字
goods. picture	String	是	商品照片
goods. goodsPrice	Double	是	商品价格
goods. miaoshaPrice	Double	是	秒杀价格
goods. kc	Integer	是	库存
goods. id	Long	是	商品id

 2.6 秒杀接口

 

5.1秒杀

接口：/miaosha/ do_miaosha

描述：秒杀

校验：session

方法：get/post

参数名	类型	是否必须	描述
goodsId	long	是	商品id

用户登录参数

参数名	类型	是否必须	描述
goods. Name	String	是	商品名字
goods. picture	String	是	商品照片
orderInfo.goodsPrice	Double	是	订单价格
orderInfo.Date	Date	是	下单时间
orderInfo.status	Integer	是	订单状态