修复bug
This commit is contained in:
120
doc/用户反馈接口文档.md
Normal file
120
doc/用户反馈接口文档.md
Normal file
@@ -0,0 +1,120 @@
|
||||
# 用户反馈接口文档
|
||||
|
||||
## 提交用户反馈
|
||||
|
||||
### 接口描述
|
||||
该接口用于C端用户提交反馈信息。
|
||||
|
||||
### 请求URL
|
||||
```
|
||||
POST /client/feedback/submit
|
||||
```
|
||||
|
||||
### 请求参数
|
||||
|
||||
| 参数名 | 类型 | 是否必须 | 说明 |
|
||||
| --- | --- | --- | --- |
|
||||
| feedbackContent | String | 是 | 反馈内容 |
|
||||
| userName | String | 否 | 用户姓名 |
|
||||
| contactType | String | 否 | 联系方式类型,如email、phone、wechat等 |
|
||||
| contactInfo | String | 否 | 联系方式信息 |
|
||||
| status | String | 否 | 处理状态(默认为'pending'):<br>- pending: 待处理<br>- processing: 处理中<br>- resolved: 已解决<br>- closed: 已关闭 |
|
||||
| attachmentPath | String | 否 | 附件路径(如果有) |
|
||||
|
||||
### 请求示例
|
||||
```json
|
||||
{
|
||||
"feedbackContent": "网站的音乐播放功能有时会出现卡顿",
|
||||
"userName": "张三",
|
||||
"contactType": "email",
|
||||
"contactInfo": "zhangsan@example.com",
|
||||
"status": "pending"
|
||||
}
|
||||
```
|
||||
|
||||
### 返回参数
|
||||
|
||||
| 参数名 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| code | Integer | 状态码,200表示成功 |
|
||||
| msg | String | 消息提示 |
|
||||
| data | Integer | 操作结果,1表示成功 |
|
||||
|
||||
### 返回示例
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "操作成功",
|
||||
"data": 1
|
||||
}
|
||||
```
|
||||
|
||||
## 查询反馈详情
|
||||
|
||||
### 接口描述
|
||||
该接口用于查询特定反馈的详细信息。
|
||||
|
||||
### 请求URL
|
||||
```
|
||||
GET /client/feedback/detail/{id}
|
||||
```
|
||||
|
||||
### 路径参数
|
||||
|
||||
| 参数名 | 类型 | 是否必须 | 说明 |
|
||||
| --- | --- | --- | --- |
|
||||
| id | String | 是 | 反馈ID |
|
||||
|
||||
### 返回参数
|
||||
|
||||
| 参数名 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| code | Integer | 状态码,200表示成功 |
|
||||
| msg | String | 消息提示 |
|
||||
| data | Object | 反馈详情对象 |
|
||||
|
||||
#### data对象结构
|
||||
|
||||
| 参数名 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| id | String | 唯一标识符 |
|
||||
| feedbackContent | String | 反馈内容 |
|
||||
| userName | String | 用户姓名 |
|
||||
| contactType | String | 联系方式类型 |
|
||||
| contactInfo | String | 联系方式信息 |
|
||||
| status | String | 处理状态:<br>- pending: 待处理<br>- processing: 处理中<br>- resolved: 已解决<br>- closed: 已关闭 |
|
||||
| createdAt | Date | 创建时间 |
|
||||
| updatedAt | Date | 更新时间 |
|
||||
| ipAddress | String | 用户IP地址 |
|
||||
| userAgent | String | 用户浏览器信息 |
|
||||
| attachmentPath | String | 附件路径 |
|
||||
|
||||
### 返回示例
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "操作成功",
|
||||
"data": {
|
||||
"id": "a1b2c3d4e5f6",
|
||||
"feedbackContent": "网站的音乐播放功能有时会出现卡顿",
|
||||
"userName": "张三",
|
||||
"contactType": "email",
|
||||
"contactInfo": "zhangsan@example.com",
|
||||
"status": "pending",
|
||||
"createdAt": "2025-08-21",
|
||||
"updatedAt": "2025-08-21",
|
||||
"ipAddress": "192.168.1.1",
|
||||
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
|
||||
"attachmentPath": null
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 状态码说明
|
||||
|
||||
| 状态码 | 说明 |
|
||||
| --- | --- |
|
||||
| 200 | 成功 |
|
||||
| 400 | 请求参数错误 |
|
||||
| 401 | 未授权 |
|
||||
| 500 | 服务器内部错误 |
|
||||
Reference in New Issue
Block a user