反馈使用指南
反馈处理流程
说明客户端反馈上报、附件补传与后台处理的操作流程。
- 创建路由
- /api/feedbacks
- 附件路由
- /api/feedbacks/:feedbackId/attachments
- 后台列表路由
- /api/feedbacks
上报分为 JSON 和 multipart 两段
先用 JSON 创建反馈记录,等 feedbackId 返回后,再通过 multipart/form-data 上传截图或日志包。
客户端流程
上报流程
客户端先创建反馈记录,再按需补传附件。
客户端应先调用 POST /api/feedbacks 创建反馈记录,再进行任何附件上传。
当 201 响应返回 feedbackId 和 attachments: [] 后,客户端即可继续上传截图或日志文件。
- 内联日志 logText 属于创建反馈的 JSON 载荷。
- 二进制截图和日志包应通过附件上传路由提交。
推荐顺序
建议的请求时序
一条典型的问题反馈,通常从客户端发起并最终进入后台处理。
- 1. POST /api/feedbacks
- 2. POST /api/feedbacks/:feedbackId/attachments
- 3. GET /api/feedbacks
- 4. GET /api/feedbacks/:feedbackId
- 5. PATCH /api/feedbacks/:feedbackId/status
后台流程
后台处理流程
管理员通过列表筛选、详情查看和状态切换来完成处理。
后台列表依赖 GET /api/feedbacks 按状态、类型、来源应用、平台、版本、关键词和时间范围进行筛选。
管理员开始跟进后,可通过 PATCH /api/feedbacks/:feedbackId/status 将记录标记为 processing;处理完成后再标记为 processed,并附带可选 adminNote。
处理说明
当记录被标记为 processed 时,系统会把管理员用户名写入
processedBy,并保留可选 的 adminNote。若后续需要继续排查,可再切回 unprocessed。