@ (#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,34 @@
+# POST /api/v1/compare/milestones/{milestone}/claim — 领取比价战绩里程碑奖励
+
+> 所属:比价记录组（前缀 `/api/v1/compare`） | 鉴权:Bearer | [← 返回 API 索引](../README.md)
+
+领取某一档(第 `milestone` 次)。⚠️ **当前不真发金币**(产品定,后续整体删除该功能):仍写
+`comparison_milestone_claim`((user_id, milestone) 唯一)标记该档已领、**每档只能领一次**,但不调
+`grant_coins`、不写 `coin_transaction`,余额不变,`coin_awarded` 恒为 0。进度口径见
+[milestones 进度接口](./compare-milestones.md)。
+
+## 入参
+- 路径参数 `milestone`(int):档位序号,1..6(= `RECORD_MILESTONES` 长度)。
+
+## 出参
+响应 `200`：
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `milestone` | int | 本次领取的档位序号 |
+| `coin_awarded` | int | 本次发放金币(当前恒为 `0`,暂不真发) |
+| `coin_balance` | int | 领奖后金币余额(当前不变) |
+
+```json
+{ "milestone": 1, "coin_awarded": 0, "coin_balance": 29087 }
+```
+
+## 错误
+- `401` 未鉴权
+- `404` 档位越界(`unknown milestone`,milestone < 1 或 > 档位总数)
+- `409` 该档还没解锁(`milestone locked`,成功比价次数 < milestone)
+- `409` 该档已领过(`milestone already claimed`)
+
+## 说明
+- 当前不发金币,客户端领取后只需把本档状态刷成 claimed 即可;若后续恢复发奖,再按 `coin_awarded` 刷新钱包余额([`GET /api/v1/wallet/account`](./wallet-account.md))。
+- 幂等:重复领同一档返回 409(唯一约束 + 领取前查重)。
@@ -0,0 +1,53 @@
+# GET /api/v1/compare/milestones — 比价战绩里程碑进度
+
+> 所属:比价记录组（前缀 `/api/v1/compare`） | 鉴权:Bearer | [← 返回 API 索引](../README.md)
+
+福利页「记录比价战绩」的数据源。返回各档(第 1~6 次)解锁/领取状态。
+
+**解锁进度** = 当前用户 `comparison_record` 里 `status='success'` 的条数(只算成功比价,失败的不计入)。第 N 档在「成功比价次数 ≥ N」时解锁;每档领一次(领取见 [claim 接口](./compare-milestone-claim.md))。
+
+档位金额是**产品规则**,定义在后端 `app/core/rewards.py` 的 `RECORD_MILESTONES`(当前 `120/180/300/500/800/1200`),客户端**不要写死**,以本接口返回为准。
+
+> ⚠️ **当前领取暂不真发金币**(产品定,后续整体删除该功能):`coin` 仍返回产品规则值仅供展示,但 [claim 接口](./compare-milestone-claim.md) 实际 `coin_awarded` 恒为 0、余额不变。前端展示须与之对齐,勿让用户误以为领取可到账。
+
+## 入参
+无(用户身份取自 Bearer token)。
+
+## 出参
+响应 `200`：
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `success_count` | int | 累计成功比价次数(解锁进度) |
+| `claimable_count` | int | 当前可领(state=active)的档数 |
+| `milestones` | Milestone[] | 各档状态,按 milestone 升序 |
+
+**Milestone**
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `milestone` | int | 档位序号(1-based),= 解锁所需的成功比价次数 |
+| `coin` | int | 该档**应发**金币额(产品规则值);⚠️ 当前领取不真发,见上方说明 |
+| `state` | string | `claimed`(已领) / `active`(已解锁可领) / `locked`(未解锁) |
+
+```json
+{
+  "success_count": 2,
+  "claimable_count": 1,
+  "milestones": [
+    {"milestone": 1, "coin": 120, "state": "claimed"},
+    {"milestone": 2, "coin": 180, "state": "active"},
+    {"milestone": 3, "coin": 300, "state": "locked"},
+    {"milestone": 4, "coin": 500, "state": "locked"},
+    {"milestone": 5, "coin": 800, "state": "locked"},
+    {"milestone": 6, "coin": 1200, "state": "locked"}
+  ]
+}
+```
+
+## 错误
+- `401` 未鉴权
+
+## 说明
+- 同时可有多档处于 `active`(如累计 3 次却一档没领,则前 3 档都可领),逐档调 claim。
+- 进度只增不减:领取不消耗成功次数,只是把对应档从 active→claimed。
@@ -0,0 +1,25 @@
+# GET /api/v1/compare/records/{record_id} — 比价记录详情
+
+> 所属:比价记录组（前缀 `/api/v1/compare`） | 鉴权:Bearer | [← 返回 API 索引](../README.md)
+
+单条比价记录详情，在列表项基础上额外带 `raw_payload`（客户端上报的原始全量），供未来 UI 展示任意细节。
+
+## 入参（path）
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `record_id` | int | 记录 id |
+
+## 出参
+响应 `200`：**ComparisonRecordDetailOut** = [ComparisonRecordOut](./compare-records.md#出参) 全部字段 + 下列：
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `raw_payload` | object \| null | 客户端上报的原始 body 全量（calibration + done.params） |
+
+## 错误
+- `401` 未鉴权
+- `404` 记录不存在，或不属于当前用户（限本人，避免越权读他人记录）
+
+## 说明
+`404` 同时覆盖「id 不存在」和「id 属于他人」两种情况——不区分以免泄露他人记录是否存在。
@@ -0,0 +1,60 @@
+# POST /api/v1/compare/record — 上报一次比价结果(幂等)
+
+> 所属:比价记录组（前缀 `/api/v1/compare`） | 鉴权:Bearer | [← 返回 API 索引](../README.md)
+
+比价 `done` 帧后,客户端用**带 JWT 的通道**上报一条比价结果,落 `comparison_record` 表，作为「我的比价记录」数据源 + 用户级行为画像。
+
+> ⚠️ 与不鉴权的透传端点 [`/api/v1/price/step`](./compare-price-step.md) 不同：那是转发壳，本接口按用户维度落库，**必须鉴权**。
+> 本轮只做 server 端；客户端在 done 帧后调本接口的改动另起一轮（见 [待办与技术债.md](../guides/待办与技术债.md) P1）。
+
+## 入参（JSON body）
+
+字段刻意对齐 pricebot 协议（[02_api_protocol.md](../../../pricebot-backend/docs/main/02_api_protocol.md) 的 `calibration` + `done.params`），客户端把 Phase1 的 calibration 和 done 帧 params **零翻译**映射上来即可。
+
+| 字段 | 类型 | 必填 | 默认 | 说明 |
+|---|---|---|---|---|
+| `trace_id` | string | ✅ | — | pricebot 侧 trace_id。**幂等键**：同用户同 trace_id 重复上报覆盖、返回同一 id |
+| `business_type` | string | ❌ | `food` | `food`(外卖,当前唯一接通) / `ecom`(电商) / `coupon`(领券) |
+| `device_id` | string \| null | ❌ | null | 设备号 |
+| `store_name` | string \| null | ❌ | null | 店铺名（外卖,来自 calibration.result） |
+| `source_platform_id` | string \| null | ❌ | null | 源平台代号，如 `taobao_flash` |
+| `source_platform_name` | string \| null | ❌ | null | 源平台中文名 |
+| `source_package` | string \| null | ❌ | null | 源平台 Android 包名 |
+| `source_price` | float \| null | ❌ | null | 源平台到手价（**元**） |
+| `items` | Item[] | ❌ | [] | 下单菜品，`{name, qty, specs?}` |
+| `comparison_results` | Result[] | ❌ | [] | 逐平台对比，见下表（price 单位**元**） |
+| `skipped_dish_count` | int \| null | ❌ | null | 目标平台未找到、跳过的菜品数 |
+| `skipped_dish_names` | string[] | ❌ | [] | 被跳过的菜名 |
+| `total_dish_count` | int \| null | ❌ | null | 原始菜品总数 |
+| `information` | string \| null | ❌ | null | done 帧文案(成功摘要 / 失败具体原因),持久化为列并在列表/详情返回,前端失败时当原因展示 |
+| `status` | string \| null | ❌ | null | `success` / `failed`。**不传则服务端派生** |
+
+**Item**：`{ name: string, qty: int=1, specs: string[]\|null }`
+
+**Result（comparison_results 元素）**：`{ platform_id, platform_name, package, price(元,float\|null), is_source(bool), rank(int\|null), coupon_saved(元,float\|null), coupon_name(string\|null) }`
+
+- `coupon_saved`：该平台本单**平台主优惠额**（元）——美团红包 / 淘宝平台红包 / 京东优惠券·百亿补贴，**只取那一笔**，不含配送费减免/共减总额。仅外卖目标平台带值，源平台/没用为 `null`，前端记录页据此展示**「已优惠 ¥X」**（null 不展示）。
+- `coupon_name`：优惠**来源名**（展示用，best-effort）——美团「外卖大额神券」/ 京东「百亿补贴」/ 淘宝「平台红包」。仅在该行有 `coupon_saved` 时带；`null` 时前端走通用「红包」。非用户选中的具体券名（选中态不可读）。
+
+## 服务端派生（客户端不用算）
+
+从 `comparison_results` 派生并落结构化列：
+
+- `best_*`：取最便宜的一家（按 `rank` 升序、再按 `price`），写 `best_platform_id/name/best_price_cents`
+- `source_price_cents`：优先用 `source_price`，缺失则取 `comparison_results` 里 `is_source=true` 行的价
+- `saved_amount_cents` = `源价 − 最优价`（可为 0 / 负：源平台本来就最便宜）
+- `is_source_best`：最便宜的一家是否为源平台（= 这次没省到）
+- `status`（未显式传时）：存在「非源且有价」的结果 → `success`，否则 → `failed`
+- 金额一律 `round(元 × 100)` 存**分**
+
+`comparison_results` / `items` / `skipped_dish_names` 原样存 JSON；完整上报 body 另存 `raw_payload`（详情接口可取回）。
+
+## 出参
+响应 `200`：`{ "id": int }`（写入或已存在记录的 id）
+
+## 错误
+- `401` 未鉴权
+- `422` 缺 `trace_id` 或字段类型不符
+
+## 说明
+失败的比价（done 帧只有源/空 comparison_results）也会落一条 `status=failed`——「越详细越好」，是否在 UI 展示由前端过滤。
@@ -0,0 +1,47 @@
+# GET /api/v1/compare/records — 比价记录列表(游标分页)
+
+> 所属:比价记录组（前缀 `/api/v1/compare`） | 鉴权:Bearer | [← 返回 API 索引](../README.md)
+
+「我的比价记录」列表页数据源。按 `id` 倒序（最新在前）。
+
+## 入参（query）
+
+| 字段 | 类型 | 必填 | 默认 | 说明 |
+|---|---|---|---|---|
+| `limit` | int | ❌ | 20 | 1–100 |
+| `cursor` | int | ❌ | null | 上一页末条 `id`,首页不传 |
+
+## 出参
+响应 `200`：`{ items: ComparisonRecordOut[], next_cursor: int|null }`（分页见 [索引#游标分页约定](./README.md#游标分页约定)）
+
+**ComparisonRecordOut**（列表项，不含 `raw_payload`，减小 payload）
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `id` | int | 记录 id（也是游标） |
+| `business_type` | string | `food` / `ecom` / `coupon` |
+| `trace_id` | string | pricebot trace_id |
+| `source_platform_id` | string \| null | 源平台代号 |
+| `source_platform_name` | string \| null | 源平台中文名 |
+| `source_package` | string \| null | 源平台包名 |
+| `source_price_cents` | int \| null | 源平台到手价（分） |
+| `best_platform_id` | string \| null | 最优平台代号 |
+| `best_platform_name` | string \| null | 最优平台中文名 |
+| `best_price_cents` | int \| null | 最优价（分） |
+| `saved_amount_cents` | int \| null | 省下（分，可 0/负） |
+| `is_source_best` | bool \| null | 源平台是否最便宜（= 没省到） |
+| `store_name` | string \| null | 店铺名 |
+| `total_dish_count` | int \| null | 菜品总数 |
+| `skipped_dish_count` | int \| null | 跳过菜品数 |
+| `status` | string | `success` / `failed` |
+| `information` | string \| null | done 帧文案。成功:"在美团找到同店,到手价 ¥X…";失败:具体原因(如"美团、京东外卖均未找到该商品"),前端在 `status=failed` 时当原因展示 |
+| `items` | object[] | 下单菜品 `{name, qty, specs?}` |
+| `comparison_results` | object[] | 逐平台对比（price 单位元，已按 rank 升序） |
+| `skipped_dish_names` | string[] | 被跳过的菜名 |
+| `created_at` | datetime | 时间 |
+
+## 错误
+- `401` 未鉴权
+
+## 说明
+只返回当前登录用户自己的记录。需要单条全量（含 `raw_payload`）走 [详情接口](./compare-record-detail.md)。
@@ -0,0 +1,25 @@
+# GET /api/v1/compare/stats — 比价口径战绩（「我的」页省钱战绩卡）
+
+> 所属:比价记录组（前缀 `/api/v1/compare`） | 鉴权:Bearer | [← 返回 API 索引](../README.md)
+
+## 入参
+无（用户由 token 确定）。
+
+## 出参
+响应 `200`:`CompareStatsOut`
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `compare_count` | int | 累计完成比价次数（`comparison_record` 中 `status='success'` 的记录数） |
+| `discovered_saved_cents` | int | 累计发现可省额（分；各成功比价 `saved_amount_cents`=源价−最低价 之和，null 不计） |
+
+## 说明
+「我的」页**省钱战绩卡**的数据源（**比价口径**）：
+
+- 卡主额「累计发现可省 ¥X」← `discovered_saved_cents`
+- 卡三列之「完成比价(次)」← `compare_count`
+- 卡「未比价锁定态」判据：`compare_count == 0`（没比过价 → 盖锁定蒙层，引导「立即开始」去首页比价）
+
+> ⚠️ **与下单口径解耦**：本接口只看「比过价」(`comparison_record`)，**不要求下单**。区别于 `savings_record`（下单成交记账，见 [savings-summary](./savings-summary.md) / [savings-records](./savings-records.md)）——那是订单记录/省钱明细的源。两表互不喂数据。
+
+> 卡另两项数据源：「赚取金币」← `GET /wallet/account.total_coin_earned`；「领取优惠券」后端暂无累计字段（前端先占位）。