@ (#111)

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

---------

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

docs/api/auth/auth-jverify-login.md

@@ -0,0 +1,22 @@
+# POST /api/v1/auth/jverify-login — 极光一键登录
+
+> 所属:Auth 组（前缀 `/api/v1/auth`） | 鉴权:无 | [← 返回 API 索引](../README.md)
+>
+> 集成实现:见 [integrations/jiguang](../integrations/jiguang.md)（极光核验链路、RSA 解密策略、私钥配对踩坑）。
+
+## 入参
+
+| 字段 | 类型 | 必填 | 说明 |
+|---|---|---|---|
+| `login_token` | string | ✅（非空） | 客户端极光 `loginAuth` 拿到的 loginToken |
+| `operator` | string | ❌（默认 `""`） | 运营商标识 CM/CU/CT,仅用于后端日志 |
+
+## 出参
+响应 `200`:`TokenWithUser`（`user.register_channel` 为 `"jverify"`）。结构见 [API 索引](./README.md#复用数据结构)。
+
+## 错误码
+- `502` 极光验证或 RSA 解密失败
+- `403` 账号被禁用
+
+## 说明
+后端验真 `login_token` 取回并解密手机号 → 注册即登录（手机号不存在则建号）→ 签发 JWT。极光核验 + RSA 解密的实现细节见 [integrations/jiguang](../integrations/jiguang.md)。

docs/api/auth/auth-logout.md

@@ -0,0 +1,15 @@
+# POST /api/v1/auth/logout — 登出
+
+> 所属:Auth 组（前缀 `/api/v1/auth`） | 鉴权:Bearer access_token | [← 返回 API 索引](../README.md)
+
+## 入参
+无
+
+## 出参
+响应 `200`:`{ "ok": true }`
+
+## 错误码
+无
+
+## 说明
+服务端**无状态、不吊销 token**(占位实现),真正失效靠客户端删除本地 token。后续若加 jti 黑名单可在此写入。

docs/api/auth/auth-me.md

@@ -0,0 +1,15 @@
+# GET /api/v1/auth/me — 获取当前登录用户
+
+> 所属:Auth 组（前缀 `/api/v1/auth`） | 鉴权:Bearer access_token | [← 返回 API 索引](../README.md)
+
+## 入参
+无（身份取自 Header token）
+
+## 出参
+响应 `200`:`UserOut`。结构见 [API 索引](./README.md#复用数据结构)。
+
+## 错误码
+- `401` 未带 token / token 无效或过期 / 用户被禁用
+
+## 说明
+无

docs/api/auth/auth-refresh.md

@@ -0,0 +1,18 @@
+# POST /api/v1/auth/refresh — 刷新 token
+
+> 所属:Auth 组（前缀 `/api/v1/auth`） | 鉴权:无（凭 body 里的 refresh_token） | [← 返回 API 索引](../README.md)
+
+## 入参
+
+| 字段 | 类型 | 必填 | 说明 |
+|---|---|---|---|
+| `refresh_token` | string | ✅ | 有效的 refresh token |
+
+## 出参
+响应 `200`:`TokenPair`（**注意:不含 `user` 字段**）。结构见 [API 索引](./README.md#复用数据结构)。
+
+## 错误码
+- `401` refresh token 无效/过期/类型不对,或用户不存在/被禁用
+
+## 说明
+服务端校验 refresh token（验签 + 验过期 + 验类型为 refresh）并查库确认用户仍 active,然后签发**全新的** access+refresh 对。客户端在请求收到 401 时由 OkHttp `Authenticator` 自动调用。

docs/api/auth/auth-sms-login.md

@@ -0,0 +1,22 @@
+# POST /api/v1/auth/sms/login — 手机号 + 验证码登录
+
+> 所属:Auth 组（前缀 `/api/v1/auth`） | 鉴权:无 | [← 返回 API 索引](../README.md)
+>
+> 集成实现:见 [integrations/sms](../integrations/sms.md)（验证码校验逻辑）。
+
+## 入参
+
+| 字段 | 类型 | 必填 | 说明 |
+|---|---|---|---|
+| `phone` | string | ✅ | 手机号 `^1\d{10}$` |
+| `code` | string | ✅ | 验证码,长度 4–8 |
+
+## 出参
+响应 `200`:`TokenWithUser`（`user.register_channel` 为 `"sms"`）。结构见 [API 索引](./README.md#复用数据结构)。
+
+## 错误码
+- `400` 验证码错误
+- `403` 账号被禁用
+
+## 说明
+mock 模式下任意 6 位数字均通过校验。注册即登录。

docs/api/auth/auth-sms-send.md

@@ -0,0 +1,26 @@
+# POST /api/v1/auth/sms/send — 发送短信验证码
+
+> 所属:Auth 组（前缀 `/api/v1/auth`） | 鉴权:无 | [← 返回 API 索引](../README.md)
+>
+> 集成实现:见 [integrations/sms](../integrations/sms.md)（mock 模式、频控、接真供应商 TODO）。
+
+## 入参
+
+| 字段 | 类型 | 必填 | 说明 |
+|---|---|---|---|
+| `phone` | string | ✅ | 手机号,正则 `^1\d{10}$` |
+
+## 出参
+响应 `200`:
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `sent` | bool | 是否已发送 |
+| `mock` | bool | 是否 mock 模式（true 时不真发,任意 6 位通过） |
+| `cooldown_sec` | int | 多少秒后才能再次发送 |
+
+## 错误码
+- `429` 发送过频（默认 60s 冷却内重复发）
+
+## 说明
+mock 模式（`SMS_MOCK=true`）下不真发短信,仅记录冷却时间。