@ (#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,30 @@
+# POST /api/v1/meituan/coupons — 券列表 / 搜索
+
+> 所属:美团 CPS 组（前缀 `/api/v1/meituan`,**全部无鉴权**） | 鉴权:无 | [← 返回 API 索引](../README.md)
+>
+> 集成实现:见 [integrations/meituan](../integrations/meituan.md)（CPS S-Ca 签名、入参换算坑）。
+
+## 入参
+
+| 字段 | 类型 | 必填 | 默认 | 说明 |
+|---|---|---|---|---|
+| `longitude` | float | ✅ | — | 经度 |
+| `latitude` | float | ✅ | — | 纬度 |
+| `platform` | int | ❌ | 1 | 1=外卖/到家, 2=到店 |
+| `biz_line` | int | ❌ | null | 到店子类:1到餐 2到综 3酒店 4门票 |
+| `list_topic_id` | int | ❌ | 3 | 榜单:1精选 2今日必推 3爆款筛选 5限时筛选 |
+| `keyword` | string | ❌ | null | 搜索词（**填了则忽略 `list_topic_id`,走搜索**） |
+| `sort_field` | int | ❌ | null | 1价格 2销量 6离我最近（搜索时默认 6） |
+| `search_id` | string | ❌ | null | 翻页 token,首页不填 |
+| `page` | int | ❌ | 1 | ≥1 |
+| `page_size` | int | ❌ | 20 | 1–20 |
+
+## 出参
+响应 `200`:`{ items: CouponCard[], has_next: bool, search_id: string|null, status: "ok"|"empty"|"degraded" }`。`CouponCard` 结构见 [API 索引](./README.md#复用数据结构);`status` 语义见 [feed 接口](./meituan-feed.md#status-字段前端据此显示占位)。
+
+## 错误码
+无业务级错误码:未配凭证 / 美团调用失败都返 `200` + 空 `items` + `status=degraded`(**2026-06-10 起不再抛 502**,避免前端弹报错 toast)。
+
+## 说明
+- 当前 Android 客户端**未调用**此接口(搜索功能尚未实现),仅后端实现完整
+- **统一软降级(2026-06-10)**:未配 `MT_CPS_APP_KEY/SECRET`、或已配但调美团失败,都返空 + `status=degraded`(此前后者抛 502);成功但无结果 → `status=empty`。前端按 `status` 显示「服务繁忙」/「暂无」,不再弹错误
@@ -0,0 +1,41 @@
+# POST /api/v1/meituan/feed — 首页推荐流(多 tab)
+
+> 所属:美团 CPS 组(前缀 `/api/v1/meituan`,**全部无鉴权**) | 鉴权:无 | [← 返回 API 索引](../README.md)
+>
+> 集成实现:见 [integrations/meituan](../integrations/meituan.md)(CPS S-Ca 签名、入参换算坑);离线库见 [database/meituan_coupon](../database/meituan_coupon.md)。
+
+## 入参
+| 字段 | 类型 | 必填 | 默认 | 说明 |
+|---|---|---|---|---|
+| `longitude` | float | ✅ | — | 经度 |
+| `latitude` | float | ✅ | — | 纬度 |
+| `page` | int | ❌ | 1 | ≥1 |
+| `page_size` | int | ❌ | 20 | 1–20 |
+| `tab` | string | ❌ | `""` | `rec` 智能推荐 / `distance` 距离最近 / 空=默认混合 feed(老客户端兼容) |
+
+> 销量最高(sales)tab **不在本接口**,走 [`/top-sales`](./meituan-top-sales.md)。
+
+## 出参
+响应 `200`:`{ items: CouponCard[], has_next: bool, page: int, status: "ok"|"empty"|"degraded" }`。`CouponCard` 结构见 [API 索引](./README.md#复用数据结构)。
+
+### `status` 字段(前端据此显示占位)
+| 值 | 含义 | 前端建议 |
+|---|---|---|
+| `ok` | 有数据 | 正常渲染 |
+| `empty` | 后端正常、查询成功但确实没数据 | 显示「暂无优惠券」 |
+| `degraded` | 上游(美团)或库查询失败,已降级返空 | 显示「服务繁忙,下拉重试」 |
+
+> 老客户端不读 `status`(字段缺省即兼容),仍可只按 `items` 是否为空展示。
+
+## 各 tab 行为
+- **`rec` 智能推荐**:走【离线库 `meituan_coupon`】筛佣金率 ≥ 3%,`DISTINCT ON(dedup_key)` 去重后按销量降序分页。**纯库查询、不打美团、不依赖 MT 凭证**。库为空(prod 刚部署 / ETL 未跑完)→ `empty`;库异常 → `degraded`。**不显示距离**(库里距离相对城市默认点,对用户无意义)。
+  - 为何不实时:实测同城热销榜中位佣金 ~0.8%,筛佣金≥3% 后每页剩 0–1 条,既撞 402 又填不满,故从库出;库空时也**不回退实时**(回退同样填不满)。
+- **`distance` 距离最近**:外卖搜「外卖」+ 到店搜「美食」(均 `sortField=6`),两路并行顺序翻页,实时按你坐标算距离、由近及远。两路**都失败**且无结果 → `degraded`;否则有结果 `ok` / 无结果 `empty`。
+- **默认(空 tab)**:逐轮分页的混合 feed(2 外卖 + 1 到店交叉,写死 3 页:爆款 / 今日必推 / 精选+限时),第 4 页返空。两路榜单都失败 → `degraded`。
+
+## 错误码
+无业务级错误码:任何失败场景都返 `200` + 空 `items` + `status=degraded`(不再抛 5xx,避免前端弹报错 toast)。
+
+## 兜底说明(1.0 内测)
+- rec / sales 是库查询:**prod 刚部署、ETL 首灌未完成**时库为空 → 返 `empty`。最佳实践是**开内测前先手动跑一次 ETL 灌满库**(见 `scripts/pull_meituan_coupons.py` 与 `deploy/meituan-etl.{service,timer}`)。
+- 未配 `MT_CPS_APP_KEY/SECRET` 时:`distance` / 默认 直接 `degraded`;`rec` 仍走库(配置开关不挡纯库查询)。
@@ -0,0 +1,31 @@
+# POST /api/v1/meituan/referral-link — 换取推广链接
+
+> 所属:美团 CPS 组（前缀 `/api/v1/meituan`,**全部无鉴权**） | 鉴权:无 | [← 返回 API 索引](../README.md)
+>
+> 集成实现:见 [integrations/meituan](../integrations/meituan.md)（CPS S-Ca 签名、入参换算坑）。
+
+## 入参
+
+| 字段 | 类型 | 必填 | 默认 | 说明 |
+|---|---|---|---|---|
+| `product_view_sign` | string | ✅ | — | 券的换链主键（来自 `CouponCard`） |
+| `platform` | int | ❌ | 1 | 1=外卖/到家, 2=到店 |
+| `biz_line` | int | ❌ | null | 到店子类 |
+| `sid` | string | ❌ | 服务端默认 `sgbjia` | 渠道追踪标识 |
+| `link_type_list` | int[] | ❌ | `[1, 3]` | 1=H5长链 2=H5短链 3=deeplink |
+
+## 出参
+响应 `200`:
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `link` | string | 默认推广链接（按 data > H5(1) > deeplink(3) > 任意 兜底） |
+| `link_map` | object | 各类型链接 `{ "linkType": "url" }`,如 `{"1": "<H5>", "3": "<deeplink>"}` |
+
+## 错误码
+- `502` 美团接口失败(仅在**已配置 `MT_CPS_APP_KEY/APP_SECRET` 但调用失败**时;未配凭证场景见下)
+
+## 说明
+- 客户端实际优先用 `link_map["3"]`（deeplink）拉起美团 App,失败降级 `link_map["1"]`（H5）
+- **未配置 MT_CPS 凭证时降级**:`settings.mt_cps_configured == false` 时直接返 `{ link: "", link_map: {} }`,**不报 502**。客户端拿到空 link 时跳转会失败——客户端应做兜底(toast "暂无可用链接"或不显示「抢」按钮)
+- ⚠️ **安全**:`sid` 允许客户端传值覆盖服务端默认渠道,理论上他人可借本接口刷自己渠道的分佣;建议服务端锁定 `sid`、忽略客户端传值
@@ -0,0 +1,23 @@
+# POST /api/v1/meituan/top-sales — 销量最高(离线库)
+
+> 所属:美团 CPS 组(前缀 `/api/v1/meituan`,**全部无鉴权**) | 鉴权:无 | [← 返回 API 索引](../README.md)
+>
+> 数据来自离线库 [database/meituan_coupon](../database/meituan_coupon.md);**不实时打美团**(美团搜索对销量排序支持差、且有 402 限流)。
+
+## 入参
+| 字段 | 类型 | 必填 | 默认 | 说明 |
+|---|---|---|---|---|
+| `page` | int | ❌ | 1 | ≥1 |
+| `page_size` | int | ❌ | 20 | 1–50 |
+| `platform` | int \| null | ❌ | null | 1 只外卖 / 2 只到店 / 不填=全部(全城销量) |
+
+## 出参
+响应 `200`:`{ items: CouponCard[], has_next: bool, search_id: null, status: "ok"|"empty"|"degraded" }`。`CouponCard` 见 [API 索引](./README.md#复用数据结构);`status` 语义见 [feed 接口](./meituan-feed.md#status-字段前端据此显示占位)。
+
+## 说明
+- 从 `meituan_coupon` 取 `sale_volume_num` 非空的券,`DISTINCT ON(dedup_key)` 跨源去重(每个「品牌|名|价」只留销量最高一条,同销量再按佣金),按销量降序分页;每页只对当前 ~20 条做 `from_raw` 解析(翻页快,不全表拉取)。
+- **不依赖 MT 凭证**(纯库查询)。库为空(prod 刚部署 / ETL 未跑完)→ `status=empty`;库查询异常 → `status=degraded`。均返 `200`、不抛 5xx。
+- **仅 PostgreSQL**(`DISTINCT ON` 为 PG 专用)。
+
+## 错误码
+无业务级错误码:库空 / 异常都返 `200` + 空 `items` + 对应 `status`。