bm-site

Appearance

抢券系统开发文档 ​

1. 概述 ​

本文档旨在描述一个商家发布优惠券，用户抢券并核销的系统。系统将包括商家端发布优惠券的界面、用户端抢券和核销优惠券的界面，以及后端的业务逻辑和数据库设计。

2. 功能需求 ​

2.1 商家端 ​

  • 发布优惠券：商家可以创建优惠券，设置优惠券的类型、数量、有效期等属性。
  • 管理优惠券：商家可以查看已发布的优惠券状态，包括已抢数量、剩余数量等。

2.2 用户端 ​

  • 抢券：用户可以浏览商家发布的优惠券，并进行抢券操作。
  • 我的优惠券：用户可以查看自己抢到的优惠券，并进行核销。

2.3 核销端 ​

  • 核销优惠券：商家或工作人员可以通过特定的核销码或二维码来核销用户的优惠券。

3. 系统架构 ​

系统采用B/S架构，商家端和用户端通过Web界面进行交互，后端服务负责处理业务逻辑和数据库操作。

4. 技术选型 ​

  • 前端：React/Vue.js
  • 后端：Spring Boot
  • 数据库：MySQL
  • 服务器：Tomcat

5. 接口定义 ​

5.1 商家接口 ​

POST /api/coupons：创建优惠券 ​

请求方法 ​
  • POST
请求URL ​
  • /api/coupons
请求体 ​
参数名类型描述是否必填
merchant_idstring商家ID是
namestring优惠券名称是
typestring优惠券类型（如满减、折扣等）是
discountnumber优惠金额或折扣率根据type类型可能是必填
quantitynumber发行数量是
validFromdate有效开始日期是
validTodate有效结束日期是
请求头 ​
参数名值的示例是否必须
Content-Typeapplication/json是
AuthorizationBearer是
成功响应 ​
  • Code: 201 CREATED
  • Content:
json
{
  "success": true,
  "message": "Coupon created successfully.",
  "data": {
    "coupon_id": "generated_coupon_id",
    "merchant_id": "string",
    "name": "string",
    "type": "string",
    "discount": "number",
    "quantity": "number",
    "remaining": "number", 
    "validFrom": "date",
    "validTo": "date"
  }
}
错误响应 ​
  • Code: 400 BAD REQUEST
  • Content:
json
{
  "success": false,
  "message": "Error message."
}

GET /api/coupons：获取优惠券列表 ​

请求方法 ​
  • GET
请求URL ​
  • /api/coupons
查询参数 ​
参数名类型描述是否必填
merchant_idstring商家ID否
成功响应 ​
  • Code: 200 OK
  • Content:
json
{
  "success": true,
  "data": [
    {
      "coupon_id": "string",
      "merchant_id": "string",
      "name": "string",
      "type": "string",
      "discount": "number",
      "quantity": "number",
      "remaining": "number",
      "validFrom": "date",
      "validTo": "date"
    },
    ...
  ]
}
错误响应 ​
  • Code: 400 BAD REQUEST
  • Content:
json
{
  "success": false,
  "message": "Error message."
}

GET /api/coupons/{couponId}：获取特定优惠券详情 ​

请求方法 ​
  • GET
请求URL ​
  • /api/coupons/
路径参数 ​
参数名类型描述是否必填
couponIdstring优惠券ID是
成功响应 ​
  • Code: 200 OK
  • Content:
json
{
  "success": true,
  "data": {
    "coupon_id": "string",
    "merchant_id": "string",
    "name": "string",
    "type": "string",
    "discount": "number",
    "quantity": "number",
    "remaining": "number",
    "validFrom": "date",
    "validTo": "date"
  }
}
错误响应 ​
  • Code: 404 NOT FOUND
  • Content:
json
{
  "success": false,
  "message": "Coupon not found."
}

用户接口 ​

5.2 用户接口 ​

  • POST /api/users/coupons：用户抢券
  • GET /api/users/coupons：获取用户优惠券列表

5.3 核销接口 ​

  • POST /api/coupons/{couponId}/redeem：核销优惠券

6. 数据库设计 ​

6.1 优惠券表（coupons） ​

  • coupon_id：优惠券ID（主键）
  • merchant_id：商家ID
  • name：优惠券名称
  • type：优惠券类型（如满减、折扣等）
  • quantity：总量
  • remaining：剩余量
  • start_date：开始时间
  • end_date：结束时间

6.2 用户优惠券表（user_coupons） ​

  • user_id：用户ID
  • coupon_id：优惠券ID
  • status：状态（如：已抢、已核销）
  • redeem_code：核销码

6.3 商家表（merchants） ​

  • merchant_id：商家ID（主键）
  • name：商家名称
  • contact_info：联系方式

7. 页面设计 ​

7.1 商家发布优惠券页面 ​

  • 表单输入：优惠券名称、类型、数量、有效期等
  • 提交按钮：发布优惠券

7.2 用户抢券页面 ​

  • 优惠券列表：展示可抢的优惠券
  • 抢券按钮：用户点击抢券

7.3 用户我的优惠券页面 ​

  • 优惠券列表：展示用户已抢的优惠券
  • 核销按钮：用户点击核销

7.4 商家核销页面 ​

  • 核销码输入框：输入用户提供的核销码
  • 核销按钮：点击核销优惠券

8. 安全性考虑 ​

  • 用户认证：确保只有注册用户可以抢券和核销。
  • 数据加密：敏感数据（如核销码）需要加密存储。

9. 测试计划 ​

  • 单元测试：对每个模块进行单元测试。
  • 集成测试：测试模块间的交互。
  • 性能测试：模拟高并发抢券场景。
  • 安全测试：测试系统的安全性。

10. 部署计划 ​

  • 开发环境：本地或云服务器。
  • 测试环境：独立于开发环境的测试服务器。
  • 生产环境：部署在高可用的云平台上。

11. 维护与支持 ​

  • 提供系统使用文档和FAQ。
  • 定期更新系统，修复已知问题。
  • 提供技术支持和咨询服务。

更新: 2024-05-17 19:40:17
原文: https://www.yuque.com/tulingzhouyu/db22bv/ly29ie8818s7me0b