秒杀项目API文档

一.简介

  API全称是Application Programming Interface，也就是应用程序编程接口，API主要是一些预定的函数，

顾名思义API文档就是主要介绍应用程序编程接口的一些参数和特性，主要包含了包含了使用API所需的所有信息，详细介绍了函数、类、返回类型、参数等。

二.内容

1.response参数表

参数名	类型	内容	必要
code	int	状态信息	必要
msg	String	提示	必要
data		返回状态	必要

2.错误返回码表

500101	服务端异常
500102	Session不存在或已经失效
500103	登录密码不能为空
500104	手机号不能为空
500105	手机号格式错误
500106	手机号不存在
500107	验证码为空
500108	验证码错误
500109	密码错误
500110	商品已经秒杀完毕
500111	不能重复秒杀
code	msg

 

3.登录接口：/miaosha/do_miaosha

4.用户登录

参数名	类型	内容	必要
tell	String	手机号码	必要
password	String	密码	必要
Verification	Sting	验证码	不必要
ifVerification	int	是否需要验证码	不必要

 

5.商品列表

接口：/goods/ to_list                                                 描述：商品列表

校验：session                                                           方法：get/post

参数名	类型	内容	必要
goodsList	List<GoodsVo>	商品列表信息	必要
goods. goodsName	String	商品名字	必要
goods. goodsPrice	Double	商品价格	必要
goods. stockCount	Integer	库存	必要
goods. id	long	商品id	必要
goods. miaoshaPrice	Double	秒杀价格	必要
goods. goodsImg	String	商品照片	必要

 

6.秒杀接口

参数名	类型	内容	必要
goods. goodsName	String	商品名字	必要
goods. goodsImg	String	商品照片	必要
orderInfo.createDate	Date	下单时间	必要
orderInfo.status	Integer	订单状态	必要
orderInfo.goodsPrice	Double	订单价格	必要

7.商品详情

参数名	类型	内容	必要
goodsList	List<GoodsVo>	商品列表信息	必要
goods. goodsName	String	商品名字	必要
goods. goodsPrice	Double	商品价格	必要
goods. stockCount	Integer	库存	必要
goods. id	long	商品id	必要
goods. miaoshaPrice	Double	秒杀价格	必要
goods. goodsImg	String	商品照片	必要

三.总结

通过这次写api文档，了解了许多相关的知识，比如swagger的使用等，对API文档有了更深的了解。