JAVA电商秒杀实战第四节——API设计-CSDN博客

本文链接：https://blog.csdn.net/weixin_43966561/article/details/106560025

JAVA电商秒杀实战第四节——API设计

API接口

API接口

什么是API接口

API英文全称为：Application Programming Interface，中文意思是应用程序编程接口，它是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力。

主要作用

API之主要目的是提供应用程序与开发人员以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。提供API所定义的功能的软件称作此API的实现。API是一种接口，故而是一种抽象。

1. 登录

（1）登录的首页 (/login/to_login)

操作	内容
接口	/login/to_login
地址	https://localhost:8080/login/to_login
描述	登录主页
验证	session
方法	GET/POST
数据	JSON

请求

参数名	类型	是否必须	说明
login	String	YES	登录的html页面

请求成功

请求码	内容
200	跳转登录界面

请求失败

请求码	内容
405	找不到

（2）登录 (/login/do_login)

操作	内容
接口	/login/do_login
地址	https://localhost:8080/login/do_login
描述	开始登录判断账号密码是否正确
验证	Session
方法	GET/POST
数据	JSON

请求

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

请求成功

请求码	内容
200	跳转登录界面

请求失败

请求码	内容
500101	参数校验异常：手机号码格式不正确
500215	密码错误

（3）手机验证码登录 (/login/code)

操作	内容
接口	/login/code
地址	https://localhost:8080/login/code
描述	通过榛子云短信服务发送验证码
验证	session
方法	GET/POST
数据	JSON

请求

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

请求成功

请求码	内容
200	跳转登录界面

请求失败

请求码	内容
500101	参数校验异常：手机号码格式不正确

2. 商品

（1）商品列表(/goods/to_list)

操作	内容
接口	/goods/to_list
地址	https://localhost:8080/goods/to_list
描述	商品列表页
验证	session
方法	GET/POST
数据	JSON

请求

参数名	类型	是否必须	说明
user	MiaoshaUser	YES	用户的信息
model	Model	YES	将数据返回前端界面

请求成功

请求码	内容
200	跳转商品页面

请求失败

请求码	内容
405	找不到

（2）商品列表(goods/to_detail/{goodsId})

操作	内容
接口	/goods/to_detail/{goodsId}
地址	https://localhost:8080/goods/to_detail/{goodsId}
描述	显示商品详细信息
验证	session
方法	GET/POST
数据	JSON

请求

参数名	类型	是否必须	说明
user	MiaoshaUser	YES	用户的信息
goodsId	long	YES	数据库中商品的主键编号
model	Model	YES	将数据返回前端界面

请求成功

请求码	内容
200	跳转商品详细页面

请求失败

请求码	内容
500100	服务端异常

3. 秒杀

秒杀页面（miaosha/{path}/do_miaosha）

操作	内容
接口	miaosha/{path}/do_miaosha
地址	https://localhost:8080/miaosha/{path}/do_miaosha
描述	显示商品详细信息
验证	session
方法	GET/POST
数据	JSON