guke
a563c1ca4b
docs/api目录文档分类和补全 --------- Co-authored-by: guke <guke@autohome.com.cn> Reviewed-on: #111
41 lines
1.3 KiB
Markdown
41 lines
1.3 KiB
Markdown
# GET /api/v1/feedback/config — 反馈页二维码卡配置
|
||
|
||
> 所属:Feedback 组（前缀 `/api/v1/feedback`） | 鉴权:Bearer | [← 返回 API 索引](../README.md)
|
||
|
||
运营后台配的反馈页「加群二维码」卡配置（开关 + 二维码图 + 三行文案）。客户端进反馈页时拉取，据此渲染整张「加群二维码」卡。
|
||
|
||
## 入参
|
||
|
||
无（`user_id` 从 JWT 取）。
|
||
|
||
## 出参
|
||
|
||
响应 `200`:`FeedbackQrConfigOut`
|
||
|
||
| 字段 | 类型 | 说明 |
|
||
|---|---|---|
|
||
| `enabled` | bool | 是否展示加群二维码卡 |
|
||
| `image_url` | string \| null | 二维码图片 URL（相对 `/media` 路径）；空 → 客户端走本地兜底 |
|
||
| `title` | string | 卡片标题（如 `加入用户反馈群`） |
|
||
| `group_name` | string | 群名称（如 `傻瓜比价用户群`） |
|
||
| `subtitle` | string | 副标题/说明文案（如 `扫码加入，你的声音我们听得见`） |
|
||
|
||
Mock 出参:
|
||
```json
|
||
{
|
||
"enabled": true,
|
||
"image_url": "/media/feedback_qr/qr_default.png",
|
||
"title": "加入用户反馈群",
|
||
"group_name": "傻瓜比价用户群",
|
||
"subtitle": "扫码加入，你的声音我们听得见"
|
||
}
|
||
```
|
||
|
||
## 错误码
|
||
- `401` 未鉴权 / token 失效
|
||
|
||
## 说明
|
||
- `image_url` 是相对路径，客户端按自己的 `BASE_URL` 拼绝对地址
|
||
- `enabled=false` 时客户端隐藏整张卡
|
||
- 配置在 admin 后台 `feedback_qr` 表维护
|