@ (#111)

docs/api目录文档分类和补全 --------- Co-authored-by: guke <guke@autohome.com.cn> Reviewed-on: #111
2026-07-03 15:00:37 +08:00
parent ee132aa93b
commit a563c1ca4b
102 changed files with 2418 additions and 217 deletions
@@ -0,0 +1,100 @@
+# 邀请绑定（bind + landing-track）
+
+> 所属:Invite 组（前缀 `/api/v1/invite`） | 鉴权:bind 需 Bearer / landing-track 无需鉴权 | [← 返回 API 索引](../README.md)
+
+---
+
+## POST /bind — 绑定邀请人
+
+把当前登录用户（被邀请人）绑定到某邀请码。支持三种归因路径：clipboard（首启读剪贴板）、manual（手动输入邀请码）、fingerprint（指纹兜底反查）。绑定成功双方各发 1 万金币。
+
+### 入参
+
+| 字段 | 类型 | 必填 | 说明 |
+|---|---|---|---|
+| `invite_code` | string \| null | ❌ | 邀请码；走指纹兜底时为空 |
+| `channel` | string | ✅ | 归因来源：`clipboard` / `manual` / `fingerprint` |
+| `fingerprint` | object \| null | ❌ | 指纹兜底时必传 |
+| `fingerprint.screen` | string | - | 屏幕分辨率（如 `1080x2400`） |
+| `fingerprint.device_model` | string | - | 设备型号（如 `24115RA8EC`） |
+
+Mock 入参（clipboard 归因）:
+```json
+{
+  "invite_code": "A3F8K2",
+  "channel": "clipboard",
+  "fingerprint": null
+}
+```
+
+Mock 入参（指纹兜底）:
+```json
+{
+  "invite_code": null,
+  "channel": "fingerprint",
+  "fingerprint": {
+    "screen": "1080x2400",
+    "device_model": "24115RA8EC"
+  }
+}
+```
+
+### 出参
+
+响应 `200`:`BindInviteOut`
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `status` | string | `success` / `already_bound` / `invalid_code` / `self_invite` / `not_eligible` / `fp_not_found` |
+| `coins_awarded` | int | 本次给当前用户（被邀请人）发的金币 |
+| `message` | string | 给前端直接展示的文案 |
+
+Mock 出参:
+```json
+{
+  "status": "success",
+  "coins_awarded": 10000,
+  "message": "邀请绑定成功"
+}
+```
+
+---
+
+## POST /landing-track — 落地页指纹采集
+
+B 浏览器打开 `dl.html?ref=xxx` 时上报指纹（剪贴板归因失败时兜底）。**无需鉴权**（浏览器没 token）。
+
+### 入参
+
+| 字段 | 类型 | 必填 | 说明 |
+|---|---|---|---|
+| `ref` | string | ✅（4-16 位） | 邀请码（落地页 `?ref=`） |
+| `screen` | string | ❌ | 屏幕分辨率（如 `1080x2400`） |
+
+Mock 入参:
+```json
+{
+  "ref": "A3F8K2",
+  "screen": "1080x2400"
+}
+```
+
+### 出参
+
+响应 `200`:`LandingTrackOut`
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `status` | string | `ok` / `invalid_code` / `no_ip` |
+
+Mock 出参:
+```json
+{"status": "ok"}
+```
+
+---
+
+## 说明
+- `bind`: 绑定只在注册后首次有效（`not_eligible` = 已过新人期），自邀屏蔽
+- `landing-track`: IP/UA 服务端从 HTTP 头自动拿，JS 无需上报
+- 指纹反查窗口期由 `INVITE_FP_WINDOW_DAYS` 控制
@@ -0,0 +1,60 @@
+# GET /api/v1/invite/invitees — 我邀请的人列表
+
+> 所属:Invite 组（前缀 `/api/v1/invite`） | 鉴权:Bearer | [← 返回 API 索引](../README.md)
+
+分页查询当前用户成功邀请的人列表。邀请页小窗（取前几条）+ 完整列表页（分页加载）共用。
+
+## 入参（query）
+
+| 字段 | 类型 | 必填 | 说明 |
+|---|---|---|---|
+| `limit` | int | ❌ | 每页条数（1–50，默认 20） |
+| `offset` | int | ❌ | 偏移量（≥0，默认 0） |
+
+Mock 请求:
+```
+GET /api/v1/invite/invitees?limit=5&offset=0
+```
+
+## 出参
+
+响应 `200`:`InviteeListOut`
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `items` | list[InviteeItem] | 被邀请人列表 |
+| `items[].display_name` | string | 显示名（昵称 → 微信昵称 → 脱敏手机号，后端已兜底） |
+| `items[].avatar_url` | string \| null | 头像 URL；null = 前端画默认色块 |
+| `items[].coins` | int | 这次邀请给邀请人发的金币 |
+| `items[].invited_at` | datetime | 邀请绑定时间（ISO 8601 UTC） |
+| `total` | int | 我邀请的总人数 |
+| `has_more` | bool | 还有下一页吗 |
+
+Mock 出参:
+```json
+{
+  "items": [
+    {
+      "display_name": "省钱小王",
+      "avatar_url": "/media/avatars/u2_f1e2d3c4b5a60708.jpg",
+      "coins": 10000,
+      "invited_at": "2026-06-28T14:30:00Z"
+    },
+    {
+      "display_name": "138****1234",
+      "avatar_url": null,
+      "coins": 10000,
+      "invited_at": "2026-07-01T09:15:00Z"
+    }
+  ],
+  "total": 5,
+  "has_more": false
+}
+```
+
+## 错误码
+- `401` 未鉴权 / token 失效
+
+## 说明
+- 名字/头像降级兜底在后端算好：昵称 → 微信昵称 → 脱敏手机号
+- `limit` 钳到 [1, 50]，`offset` 钳到 ≥0
@@ -0,0 +1,48 @@
+# GET /api/v1/invite/me — 我的邀请信息
+
+> 所属:Invite 组（前缀 `/api/v1/invite`） | 鉴权:Bearer | [← 返回 API 索引](../README.md)
+
+获取当前用户的邀请码、分享链接、已邀人数、累计获得金币/奖励金，以及 7 天一轮的倒计时信息。
+
+## 入参
+
+无（`user_id` 从 JWT 取）。
+
+## 出参
+
+响应 `200`:`InviteInfoOut`
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `invite_code` | string | 我的邀请码（6-8 位） |
+| `share_url` | string | 落地页链接（含 `?ref=`），前端据此生成二维码 + 复制分享 |
+| `invited_count` | int | 已成功邀请人数 |
+| `coins_earned` | int | 累计从邀请获得的金币（v1 口径） |
+| `reward_balance_cents` | int | v2 可提现邀请奖励金（分） |
+| `reward_withdrawn_cents` | int | v2 累计提现成功的邀请奖励金（分） |
+| `countdown_days_left` | int | v2 本轮剩余天数（7 天 1 轮） |
+| `countdown_is_fresh_round` | bool | 是否刚进入新一轮（非首轮第 1 天） |
+| `countdown_text` | string | 倒计时展示文案（前端直接显示，新轮含换行） |
+
+Mock 出参:
+```json
+{
+  "invite_code": "A3F8K2",
+  "share_url": "https://app.shaguabijia.com/dl.html?ref=A3F8K2",
+  "invited_count": 5,
+  "coins_earned": 50000,
+  "reward_balance_cents": 3200,
+  "reward_withdrawn_cents": 1800,
+  "countdown_days_left": 4,
+  "countdown_is_fresh_round": false,
+  "countdown_text": "还剩 4 天"
+}
+```
+
+## 错误码
+- `401` 未鉴权 / token 失效
+
+## 说明
+- 首次调用自动生成邀请码（幂等）
+- v2 奖励金与现金隔离（`reward_balance_cents` 独立于 `cash_balance_cents`）
+- 7 天 1 轮倒计时：新用户从注册日起算