@ (#111)

docs/api目录文档分类和补全

---------

Co-authored-by: guke <guke@autohome.com.cn>
Reviewed-on: #111

docs/api/signin/signin-boost.md

@@ -0,0 +1,33 @@
+# POST /api/v1/signin/boost — 签到后看广告膨胀金币
+
+用户 Day1-Day13 当天已签到后，看完一条激励视频，由穿山甲 S2S 回调固定补发 2000 金币。本接口只用于 S2S 发奖后的确认。
+
+## 鉴权
+
+需要 Bearer token。
+
+## 请求体
+
+| 字段 | 类型 | 必填 | 说明 |
+|---|---|---:|---|
+| `ad_ref_id` | string | 是 | 穿山甲 S2S 回调的 `trans_id`。回调需先以 `extra.reward_scene=signin_boost` 完成发奖 |
+
+## 响应
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `coin_awarded` | int | 本次膨胀补发金币 |
+| `coin_balance` | int | 补发后的金币余额 |
+| `signin_date` | string | 被膨胀的签到日期，格式 `YYYY-MM-DD` |
+
+## 错误
+
+- `401`: 未登录
+- `409`: 缺少/无效广告回调记录，非本人广告，回调未发奖，当天未签到，Day14，或当天已经膨胀过
+
+## 数据写入
+
+- 本接口不直接发奖;实际写入发生在 `/ad/pangle-callback` 的 `reward_scene=signin_boost` 分支。
+- 回调写 `signin_boost_record` 新增一行，用 `(user_id, signin_date)` 唯一约束防重复。
+- 回调使 `coin_account` 增加固定 `2000` 金币。
+- 回调写入 `coin_transaction.biz_type=signin_boost`。

docs/api/signin/signin-do.md

@@ -0,0 +1,23 @@
+# POST /api/v1/signin — 执行今日签到
+
+> 所属:Signin 组（前缀 `/api/v1/signin`,本接口 POST 到前缀本身） | 鉴权:Bearer | [← 返回 API 索引](../README.md)
+
+## 入参
+无（用户由 token 确定）。
+
+## 出参
+响应 `200`:`SigninResultOut`
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `coin_awarded` | int | 本次签到发放金币 |
+| `cycle_day` | int | 本次签到落在 14 天循环第几天 |
+| `streak` | int | 签到后的连续天数 |
+| `coin_balance` | int | 签到后金币余额 |
+
+## 错误码
+- `409` 今日已签（`already signed today`）
+
+## 说明
+发金币已计入 [wallet-account](./wallet-account.md) 的余额（客户端就地刷新即可,不必另叠）。
+断签后从第 1 天重新开始;第 15 天回到第 1 天。

docs/api/signin/signin-status.md

@@ -0,0 +1,29 @@
+# GET /api/v1/signin/status — 今日签到状态 + 14 天档位
+
+> 所属:Signin 组（前缀 `/api/v1/signin`） | 鉴权:Bearer | [← 返回 API 索引](../README.md)
+
+## 入参
+无（用户由 token 确定）。
+
+## 出参
+响应 `200`:`SigninStatusOut`
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `today_signed` | bool | 今日是否已签 |
+| `consecutive_days` | int | 当前连续签到天数 |
+| `today_cycle_day` | int | 今日处于循环内第几天（1..14） |
+| `today_coin` | int | 今日签到可得金币 |
+| `can_claim` | bool | 今日是否可领（= 未签） |
+| `steps` | SigninStepOut[] | 14 天档位 |
+
+**SigninStepOut**
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `day` | int | 循环内第几天 1..14 |
+| `coin` | int | 该档金币 |
+| `status` | string | `claimed`（已领） / `today`（今日待领） / `locked`（未到） |
+
+## 说明
+福利页签到行 + 签到弹窗 14 档 timeline 数据源。断签后从第 1 天重新开始,第 15 天回到第 1 天。