|
|
@@ -0,0 +1,170 @@
|
|
|
+# 商户平台-店铺讨论模块接口文档
|
|
|
+
|
|
|
+## 模块概述
|
|
|
+
|
|
|
+本模块提供店铺讨论功能,允许用户在商户平台上针对特定店铺发表讨论、回复他人讨论,并支持讨论的列表查询和删除。类似于论坛功能,旨在增强用户与店铺之间的互动。
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## 接口列表
|
|
|
+
|
|
|
+1. [发表讨论/回复](#接口一发表讨论回复) - 用户发表新讨论或回复已有讨论
|
|
|
+2. [获取店铺讨论列表](#接口二获取店铺讨论列表) - 查询指定店铺的所有讨论记录
|
|
|
+3. [删除讨论](#接口三删除讨论) - 根据ID逻辑删除讨论记录
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## 接口一:发表讨论/回复
|
|
|
+
|
|
|
+### 接口信息
|
|
|
+
|
|
|
+- **接口名称**: 发表讨论/回复
|
|
|
+- **接口路径**: `POST /platformStoreDiscussion/post`
|
|
|
+- **请求方式**: POST
|
|
|
+- **接口描述**: 用户对店铺发表主贴讨论,或对已有讨论进行回复。
|
|
|
+
|
|
|
+### 请求参数
|
|
|
+
|
|
|
+| 参数名 | 类型 | 必填 | 说明 |
|
|
|
+|--------|------|------|------|
|
|
|
+| storeId | Integer | 是 | 店铺ID |
|
|
|
+| userId | Integer | 是 | 用户ID |
|
|
|
+| content | String | 是 | 讨论内容 |
|
|
|
+| parentId | Integer | 否 | 父级讨论ID (发表主贴填0或不传,回复填被回复ID) |
|
|
|
+
|
|
|
+### 请求示例
|
|
|
+
|
|
|
+```json
|
|
|
+{
|
|
|
+ "storeId": 1,
|
|
|
+ "userId": 1001,
|
|
|
+ "content": "这家店的服务非常到位,强烈推荐!",
|
|
|
+ "parentId": 0
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+### 响应参数
|
|
|
+
|
|
|
+```json
|
|
|
+{
|
|
|
+ "code": 200,
|
|
|
+ "success": true,
|
|
|
+ "data": true,
|
|
|
+ "msg": "发表成功"
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## 接口二:获取店铺讨论列表
|
|
|
+
|
|
|
+### 接口信息
|
|
|
+
|
|
|
+- **接口名称**: 获取店铺讨论列表
|
|
|
+- **接口路径**: `GET /platformStoreDiscussion/list`
|
|
|
+- **请求方式**: GET
|
|
|
+- **接口描述**: 获取指定店铺下的所有讨论记录,按创建时间倒序排列。
|
|
|
+
|
|
|
+### 请求参数
|
|
|
+
|
|
|
+| 参数名 | 类型 | 必填 | 说明 |
|
|
|
+|--------|------|------|------|
|
|
|
+| storeId | Integer | 是 | 店铺ID |
|
|
|
+
|
|
|
+### 请求示例
|
|
|
+
|
|
|
+```http
|
|
|
+GET /platformStoreDiscussion/list?storeId=1
|
|
|
+```
|
|
|
+
|
|
|
+### 响应参数
|
|
|
+
|
|
|
+```json
|
|
|
+{
|
|
|
+ "code": 200,
|
|
|
+ "success": true,
|
|
|
+ "data": [
|
|
|
+ {
|
|
|
+ "id": 1,
|
|
|
+ "storeId": 1,
|
|
|
+ "userId": 1001,
|
|
|
+ "content": "这家店的服务非常到位,强烈推荐!",
|
|
|
+ "parentId": 0,
|
|
|
+ "deleteFlag": 0,
|
|
|
+ "createdTime": "2025-12-30 14:00:00",
|
|
|
+ "createdUserId": 1001,
|
|
|
+ "updatedTime": "2025-12-30 14:00:00",
|
|
|
+ "updatedUserId": null
|
|
|
+ }
|
|
|
+ ],
|
|
|
+ "msg": "操作成功"
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## 接口三:删除讨论
|
|
|
+
|
|
|
+### 接口信息
|
|
|
+
|
|
|
+- **接口名称**: 删除讨论
|
|
|
+- **接口路径**: `DELETE /platformStoreDiscussion/delete/{id}`
|
|
|
+- **请求方式**: DELETE
|
|
|
+- **接口描述**: 根据讨论ID逻辑删除该条记录。
|
|
|
+
|
|
|
+### 请求参数
|
|
|
+
|
|
|
+| 参数名 | 类型 | 必填 | 说明 |
|
|
|
+|--------|------|------|------|
|
|
|
+| id | Integer | 是 | 讨论记录ID (路径参数) |
|
|
|
+
|
|
|
+### 请求示例
|
|
|
+
|
|
|
+```http
|
|
|
+DELETE /platformStoreDiscussion/delete/1
|
|
|
+```
|
|
|
+
|
|
|
+### 响应参数
|
|
|
+
|
|
|
+```json
|
|
|
+{
|
|
|
+ "code": 200,
|
|
|
+ "success": true,
|
|
|
+ "data": true,
|
|
|
+ "msg": "删除成功"
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## 业务规则说明
|
|
|
+
|
|
|
+1. **父子关系**:
|
|
|
+ - `parentId` 为 `0` 或 `null` 表示该记录是一条独立的讨论(主贴)。
|
|
|
+ - `parentId` 大于 `0` 表示该记录是对另一条讨论的回复。
|
|
|
+2. **删除逻辑**: 采用逻辑删除,更新 `delete_flag` 字段为 `1`。
|
|
|
+3. **排序规则**: 列表接口默认按 `created_time` 倒序排列,确保最新的讨论显示在最前面。
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## 数据库设计 (`store_discussion`)
|
|
|
+
|
|
|
+| 字段名 | 类型 | 说明 |
|
|
|
+|--------|------|------|
|
|
|
+| id | int | 主键,自增 |
|
|
|
+| store_id | int | 店铺ID |
|
|
|
+| user_id | int | 用户ID |
|
|
|
+| content | text | 讨论内容 |
|
|
|
+| parent_id | int | 父级讨论ID,默认为0 |
|
|
|
+| delete_flag | tinyint | 删除标记 (0:未删除, 1:已删除) |
|
|
|
+| created_time | datetime | 创建时间 |
|
|
|
+| created_user_id | int | 创建人ID |
|
|
|
+| updated_time | datetime | 修改时间 |
|
|
|
+| updated_user_id | int | 修改人ID |
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+**文档版本**: v1.0
|
|
|
+**最后更新**: 2025-12-30
|
|
|
+**维护人员**: alien
|
|
|
+
|