guke
a563c1ca4b
docs/api目录文档分类和补全 --------- Co-authored-by: guke <guke@autohome.com.cn> Reviewed-on: #111
30 lines
1003 B
Markdown
30 lines
1003 B
Markdown
# 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 天。
|