237 行
9.5 KiB
Markdown
237 行
9.5 KiB
Markdown
# 评价服务 API 文档
|
||
|
||
**服务**: `hl-review-service`
|
||
**接口总数**: 6
|
||
|
||
## 目录
|
||
|
||
- **管理端-评价审核** (6 个接口)
|
||
|
||
---
|
||
|
||
## 管理端-评价审核
|
||
|
||
### `GET` /admin/review/list
|
||
|
||
**评价列表(支持好中差评/有图/有视频筛选)**
|
||
|
||
分页查询全部评价（含待审核/已通过/已拒绝），支持按评价等级、是否有图/视频、目标类型筛选
|
||
|
||
**关联字典**：
|
||
- review_status：评价审核状态（列表筛选+显示）
|
||
- rating_level：评价等级（列表筛选+显示）
|
||
|
||
**查询参数**
|
||
|
||
| 参数 | 类型 | 必填 | 说明 | 示例 |
|
||
| --- | --- | --- | --- | --- |
|
||
| `hasImage` | `boolean` | | 是否有图片: true/false | |
|
||
| `hasVideo` | `boolean` | | 是否有视频: true/false | |
|
||
| `keyword` | `string` | | 搜索关键词 | 风景 |
|
||
| `maxRating` | `integer(int32)` | | 最高评分(整体满意度) | 5 |
|
||
| `minRating` | `integer(int32)` | | 最低评分(整体满意度) | 3 |
|
||
| `page` | `integer(int32)` | | 页码 | 1 |
|
||
| `pageSize` | `integer(int32)` | | 每页条数 | 20 |
|
||
| `productType` | `string` | | 产品类型（字典 review_product_type） | CORE |
|
||
| `ratingLevel` | `string` | | 评价等级: GOOD/MEDIUM/BAD | GOOD |
|
||
| `reviewType` | `string` | | 评论类型（字典 review_type） | PRODUCT |
|
||
| `status` | `string` | | 评价状态 | APPROVED |
|
||
| `targetId` | `integer(int64)` | | 评价目标ID | 2001 |
|
||
| `targetType` | `string` | | 评价目标类型 | PRODUCT |
|
||
|
||
**响应** `统一响应结果«分页结果«评价列表项(管理端)»»`
|
||
|
||
| 字段 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `code` | `int` | | 状态码 |
|
||
| `data` | `分页结果«评价列表项(管理端)»` | | 响应数据 |
|
||
| `page` | `int` | | 当前页码 |
|
||
| `pageSize` | `int` | | 每页条数 |
|
||
| `records` | `评价列表项(管理端)[]` | | 数据列表 |
|
||
| `auditedAt` | `string` | | 审核时间 |
|
||
| `auditorName` | `string` | | 审核人姓名 |
|
||
| `content` | `string` | | 评价内容 |
|
||
| `createdAt` | `string` | | 创建时间 |
|
||
| `hasReply` | `boolean` | | 是否已回复 |
|
||
| `imageCount` | `int` | | 图片数量 |
|
||
| `orderId` | `string` | | 订单ID |
|
||
| `orderNo` | `string` | | 订单编号 |
|
||
| `productType` | `string` | | 产品类型 |
|
||
| `productTypeLabel` | `string` | | 产品类型标签 |
|
||
| `ratingAccommodation` | `int` | | 住宿安排评分(1-5) |
|
||
| `ratingDining` | `int` | | 餐饮质量评分(1-5) |
|
||
| `ratingDriver` | `int` | | 司机服务评分(1-5) |
|
||
| `ratingItinerary` | `int` | | 行程安排评分(1-5) |
|
||
| `ratingLevel` | `string` | | 评价等级: GOOD/MEDIUM/BAD |
|
||
| `ratingLevelLabel` | `string` | | 评价等级标签 |
|
||
| `ratingOverall` | `int` | | 整体满意度评分(1-5) |
|
||
| `rejectReason` | `string` | | 拒绝原因 |
|
||
| `reviewId` | `string` | | 评价ID |
|
||
| `reviewType` | `string` | | 评论类型 |
|
||
| `reviewTypeLabel` | `string` | | 评论类型标签 |
|
||
| `status` | `string` | | 评价状态 |
|
||
| `statusLabel` | `string` | | 评价状态标签 |
|
||
| `targetId` | `string` | | 评价目标ID |
|
||
| `targetName` | `string` | | 评价目标名称 |
|
||
| `targetType` | `string` | | 评价目标类型 |
|
||
| `targetTypeLabel` | `string` | | 评价目标类型标签 |
|
||
| `userAvatar` | `string` | | 用户头像 |
|
||
| `userNickname` | `string` | | 用户昵称 |
|
||
| `videoCount` | `int` | | 视频数量 |
|
||
| `total` | `int` | | 总记录数 |
|
||
| `message` | `string` | | 响应消息 |
|
||
|
||
---
|
||
|
||
### `GET` /admin/review/{reviewId}
|
||
|
||
**评价详情**
|
||
|
||
**关联字典**：
|
||
- review_status：评价审核状态（显示）
|
||
- rating_level：评价等级（显示）
|
||
|
||
**路径参数**
|
||
|
||
| 参数 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `reviewId` | `integer` | | 评价ID |
|
||
|
||
**响应** `统一响应结果«评价详情»`
|
||
|
||
| 字段 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `code` | `int` | | 状态码 |
|
||
| `data` | `评价详情` | | 响应数据 |
|
||
| `adminReply` | `string` | | 管理员回复内容 |
|
||
| `adminReplyAt` | `string` | | 回复时间 |
|
||
| `adminReplyName` | `string` | | 回复管理员姓名 |
|
||
| `auditedAt` | `string` | | 审核时间 |
|
||
| `auditorAdminId` | `string` | | 审核人ID |
|
||
| `auditorName` | `string` | | 审核人姓名 |
|
||
| `content` | `string` | | 评价内容 |
|
||
| `createdAt` | `string` | | 创建时间 |
|
||
| `departureDate` | `string` | | 出发日期(冗余自订单) |
|
||
| `hasImage` | `boolean` | | 是否有图片 |
|
||
| `hasVideo` | `boolean` | | 是否有视频 |
|
||
| `imageCount` | `int` | | 图片数量 |
|
||
| `images` | `评价图片信息[]` | | 评价图片列表 |
|
||
| `fileId` | `string` | | 文件ID |
|
||
| `imageId` | `string` | | 图片ID |
|
||
| `imageUrl` | `string` | | 图片URL |
|
||
| `sortOrder` | `int` | | 排序序号 |
|
||
| `machineResult` | `string` | | 机审结果 |
|
||
| `orderId` | `string` | | 订单ID |
|
||
| `orderNo` | `string` | | 订单编号 |
|
||
| `productType` | `string` | | 产品类型 |
|
||
| `productTypeLabel` | `string` | | 产品类型标签 |
|
||
| `ratingAccommodation` | `int` | | 住宿安排评分(1-5) |
|
||
| `ratingDining` | `int` | | 餐饮质量评分(1-5) |
|
||
| `ratingDriver` | `int` | | 司机服务评分(1-5) |
|
||
| `ratingItinerary` | `int` | | 行程安排评分(1-5) |
|
||
| `ratingLevel` | `string` | | 评价等级: GOOD/MEDIUM/BAD |
|
||
| `ratingLevelLabel` | `string` | | 评价等级标签: 好评/中评/差评 |
|
||
| `ratingOverall` | `int` | | 整体满意度评分(1-5) |
|
||
| `rejectReason` | `string` | | 拒绝原因 |
|
||
| `reviewId` | `string` | | 评价ID |
|
||
| `reviewType` | `string` | | 评论类型 |
|
||
| `reviewTypeLabel` | `string` | | 评论类型标签 |
|
||
| `status` | `string` | | 评价状态 |
|
||
| `statusLabel` | `string` | | 评价状态标签 |
|
||
| `targetId` | `string` | | 评价目标ID |
|
||
| `targetName` | `string` | | 评价目标名称 |
|
||
| `targetType` | `string` | | 评价目标类型 |
|
||
| `targetTypeLabel` | `string` | | 评价目标类型标签 |
|
||
| `userAvatar` | `string` | | 用户头像 |
|
||
| `userId` | `string` | | 用户ID |
|
||
| `userNickname` | `string` | | 用户昵称 |
|
||
| `videoCount` | `int` | | 视频数量 |
|
||
| `videos` | `评价视频信息[]` | | 评价视频列表 |
|
||
| `coverUrl` | `string` | | 视频封面URL |
|
||
| `duration` | `int` | | 视频时长(秒) |
|
||
| `fileId` | `string` | | 文件ID |
|
||
| `sortOrder` | `int` | | 排序序号 |
|
||
| `videoId` | `string` | | 视频ID |
|
||
| `videoUrl` | `string` | | 视频URL |
|
||
| `message` | `string` | | 响应消息 |
|
||
|
||
---
|
||
|
||
### `POST` /admin/review/{reviewId}/approve
|
||
|
||
**通过评价**
|
||
|
||
审核通过评价，通过后评价在小程序端公开展示。状态流转：PENDING_REVIEW → APPROVED
|
||
|
||
**路径参数**
|
||
|
||
| 参数 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `reviewId` | `integer` | | 评价ID |
|
||
|
||
**响应** `统一响应结果«Void»`
|
||
|
||
---
|
||
|
||
### `POST` /admin/review/{reviewId}/override-approve
|
||
|
||
**覆盖通过(机器拒绝的)**
|
||
|
||
对阿里云内容审核自动拒绝的评价进行人工覆盖通过。状态流转：AUTO_REJECTED → APPROVED
|
||
|
||
**路径参数**
|
||
|
||
| 参数 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `reviewId` | `integer` | | 评价ID |
|
||
|
||
**响应** `统一响应结果«Void»`
|
||
|
||
---
|
||
|
||
### `POST` /admin/review/{reviewId}/reject
|
||
|
||
**拒绝评价**
|
||
|
||
审核拒绝评价，需填写拒绝原因。拒绝后评价不公开展示。状态流转：PENDING_REVIEW → REJECTED
|
||
|
||
**路径参数**
|
||
|
||
| 参数 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `reviewId` | `integer` | | 评价ID |
|
||
|
||
**请求体** `拒绝评价请求`
|
||
|
||
| 字段 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `rejectReason` | `string` | 是 | 拒绝原因 |
|
||
|
||
**响应** `统一响应结果«Void»`
|
||
|
||
---
|
||
|
||
### `POST` /admin/review/{reviewId}/reply
|
||
|
||
**回复评价(每条评价仅可回复一次)**
|
||
|
||
管理员回复用户评价，回复内容在小程序端公开展示。每条评价仅允许回复一次，不可修改。
|
||
|
||
**权限**：需管理员登录。
|
||
|
||
**路径参数**
|
||
|
||
| 参数 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `reviewId` | `integer` | | 评价ID |
|
||
|
||
**请求体** `管理员回复请求`
|
||
|
||
| 字段 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `replyContent` | `string` | 是 | 回复内容 |
|
||
|
||
**响应** `统一响应结果«Void»`
|
||
|
||
---
|