JAVA电商学习之api设计
个人不是很理解API,就参考了博客上相关的文章,并根据最近的商城秒杀学习梳理了一篇API设计
1.商品
1.1显示秒杀商品列表
接口地址:/goods/to_list
请求类型:get
接口描述:显示所有参与秒杀活动的商品
变量名 | 含义 | 类型 |
goodsName | 商品名称 | String |
goodslmg | 商品图片地址 | String |
miaoshaPrice | 商品秒杀价 | Double |
goodsPrice | 商品原价 | Double |
stockCount | 商品库存 | Integer |
id | 商品id | Long |
1.2.显示秒杀商品详情
接口地址:/goods/to_detail
请求类型:get
接口描述:显示商品的详细信息
1.2.1 request参数
变量名 | 含义 | 类型 |
user | 用户名称 | MiaoshaUser |
id | 商品id | Long |
1.2.2 response参数
变量名 | 定义 | 类型 |
goodsName | 商品名称 | String |
goodslmg | 商品图片地址 | String |
miaoshaPrice | 商品秒杀价 | Double |
goodsPrice | 商品原价 | Double |
stockCount | 商品库存 | Integer |
2.秒杀
2.1秒杀
接口地址:/miaosha/do_miaosha
接口描述:进行秒杀,先判断秒杀库,判断是否已经秒杀到,最后进行秒杀步骤:减库存 创建普通订单 创建秒杀订单
2.1.1 request参数
变量名 | 含义 | 类型 |
goodid | 商品id | Long |
id | 商品id | Long |
2.1.2 response参数 成功:
变量名 | 含义 | 类型 | 备注 |
goodsName | 商品名称 | String | |
goodsImg | 商品图片地址 | String | |
goodsPrice | 订单价格 | Double | |
status | 订单状态 | Integer | 订单状态,0新建未支付, 1已支付,2已发货, 3已收货, 4已退款,5已完成 |
createDate | 下单时间 | Date |
2.1.3 response参数 失败:
变量名 | 含义 | 类型 | 备注 |
errmsg | 出错信息 | String | 1. 商品已经秒杀完毕2.不能重复秒杀 |