主题
前台接口说明
按消费者购物流程,说明前台商城每个功能对应的接口。
一、首页与浏览
这些接口都是公开的,游客也能访问。
获取首页数据
- 用途:打开首页时加载轮播广告、推荐商品、品牌等
- 接口:
GET /api/home/content - 返回:轮播图列表、新品推荐、人气推荐、品牌推荐、专题推荐
按分类获取商品
- 用途:点击某个分类后,展示该分类下的商品
- 接口:
GET /api/product/listByCategory - 参数:分类 ID、页码、每页数量
- 返回:商品列表(含图片、名称、价格、销量)
搜索商品
- 用途:输入关键词搜索商品
- 接口:
GET /api/product/search - 参数:关键词、页码
- 返回:匹配的商品列表
获取商品详情
- 用途:打开商品详情页
- 接口:
GET /api/product/detail/{id} - 返回:商品信息、规格属性、SKU 列表、评价统计
二、会员账号
注册
- 用途:新用户注册
- 接口:
POST /member/register - 参数:用户名、密码、手机号、验证码
- 说明:注册成功后自动设置昵称=用户名、初始积分=0
登录
- 用途:会员登录
- 接口:
POST /member/login - 参数:用户名(或手机号)+ 密码
- 返回:Token(身份凭证)、会员信息
- 说明:支持用户名或手机号登录
获取个人信息
- 用途:查看当前登录会员的信息
- 接口:
GET /member/info - 返回:昵称、头像、积分、成长值、会员等级
修改个人信息
- 用途:修改昵称或头像
- 接口:
POST /member/update - 参数:昵称、头像 URL
三、收货地址
地址列表
- 用途:查看我的所有收货地址
- 接口:
GET /member/address/list - 返回:地址列表(含是否默认标记)
添加地址
- 用途:新增一个收货地址
- 接口:
POST /member/address/add - 参数:收货人、手机号、省市区、详细地址
- 说明:每个用户最多 10 个地址
修改地址
- 用途:编辑已有地址
- 接口:
POST /member/address/update/{id}
删除地址
- 用途:删除一个地址
- 接口:
POST /member/address/delete/{id} - 说明:如果删除的是默认地址,系统自动将最近创建的地址设为默认
四、购物车
获取购物车
- 用途:查看购物车里的商品
- 接口:
GET /api/cart/list - 返回:购物车商品列表(含商品信息、数量、单价、选中状态)
添加到购物车
- 用途:把商品加入购物车
- 接口:
POST /api/cart/add - 参数:商品 ID、SKU ID、数量
- 说明:必须登录后才能操作
修改数量
- 用途:调整购物车中某个商品的数量
- 接口:
POST /api/cart/update
切换选中
- 用途:勾选/取消勾选某个商品(结算时只结算选中的)
- 接口:
POST /api/cart/check
删除购物车商品
- 用途:从购物车移除商品
- 接口:
POST /api/cart/delete
五、订单
确认订单
- 用途:下单前确认信息(地址、商品、优惠券)
- 接口:
GET /api/order/confirmOrder - 返回:选中的购物车商品、收货地址、可用优惠券、金额明细
提交订单
- 用途:正式下单
- 接口:
POST /api/order/generateOrder - 参数:地址 ID、优惠券 ID(可选)
- 返回:订单号、应付金额
模拟支付
- 用途:完成支付(当前为模拟,非真实支付)
- 接口:
POST /api/order/paySuccess - 参数:订单号、支付方式
订单列表
- 用途:查看我的订单
- 接口:
GET /api/order/list - 参数:订单状态(可选:待付款/待发货/待收货/已完成)
- 返回:订单列表
订单详情
- 用途:查看某个订单的详细信息
- 接口:
GET /api/order/detail/{orderSn} - 返回:商品信息、地址、金额、物流信息、操作历史
取消订单
- 用途:取消未支付的订单
- 接口:
POST /api/order/cancelOrder
确认收货
- 用途:确认收到商品
- 接口:
POST /api/order/confirmReceive
六、售后
申请退货
- 用途:对已收到的商品申请退货
- 接口:
POST /api/returnApply/create - 参数:订单商品 ID、退货原因、说明、联系电话
退货列表
- 用途:查看我的退货申请
- 接口:
GET /api/returnApply/list - 返回:退货申请列表(含状态:待审核/退货中/已完成/已拒绝)
七、商品评价
获取评价列表
- 用途:查看商品的用户评价
- 接口:
GET /api/product/comment/list - 参数:商品 ID、类型筛选(全部/有图/好评/中评/差评)
- 返回:评价列表(含评分、内容、图片、用户信息)
获取商家回复
- 用途:查看某条评价的商家回复
- 接口:
GET /api/product/comment/replayList/{commentId}
八、收藏与历史
收藏商品
- 用途:收藏/取消收藏一个商品
- 接口:
POST /api/member/productCollection/add(收藏) - 接口:
POST /api/member/productCollection/delete(取消收藏)
收藏列表
- 用途:查看我收藏的商品
- 接口:
GET /api/member/productCollection/list
浏览历史
- 用途:查看最近浏览过的商品(自动记录)
- 接口:
GET /api/member/readHistory/list - 说明:打开商品详情时自动记录,按日期分组展示
九、优惠券
领取优惠券
- 用途:领取平台发放的优惠券
- 接口:
POST /api/member/coupon/receive
我的优惠券
- 用途:查看已领取的优惠券
- 接口:
GET /api/member/coupon/list - 参数:使用状态(未使用/已使用/已过期)