| 1 | # auth API |
| 2 | |
| 3 | ## 模块边界 |
| 4 | |
| 5 | 登录、验证码与当前用户信息。 |
| 6 | |
| 7 | ## 文件清单 |
| 8 | |
| 9 | - `auth.api.ts` |
| 10 | - `auth.types.ts` |
| 11 | |
| 12 | ## 接口清单 |
| 13 | |
| 14 | | 方法 | 请求 | 说明 | |
| 15 | | ------------------- | ------------------------- | ---------------------------- | |
| 16 | | `emailCodeLoginApi` | `POST login/mail/verify` | 邮箱验证码登录 | |
| 17 | | `getUserInfoApi` | `GET user/mine` | Get Current User Information | |
| 18 | | `googleLoginApi` | `POST login/google` | Google 登录 | |
| 19 | | `phoneCodeLoginApi` | `POST login/phone/verify` | 手机验证码登录 | |
| 20 | | `sendEmailCodeApi` | `POST login/mail` | 发送邮箱验证码 | |
| 21 | | `sendPhoneCodeApi` | `POST login/phone` | 发送手机验证码 | |
| 22 | | `updateUserInfoApi` | `PUT user/info/update` | Update User Information | |
| 23 | |
| 24 | ## 类型清单 |
| 25 | |
| 26 | | 名称 | 类型 | 说明 | |
| 27 | | ---------------------- | ----------- | ------------------------------- | |
| 28 | | `AuthRequestOptions` | `interface` | 鉴权请求选项。 | |
| 29 | | `CodeLoginResponse` | `interface` | CodeLoginResponse 响应数据。 | |
| 30 | | `EmailCodeLoginParams` | `interface` | EmailCodeLoginParams 请求参数。 | |
| 31 | | `GoogleLoginParams` | `interface` | GoogleLoginParams 请求参数。 | |
| 32 | | `LoginResponse` | `interface` | LoginResponse 响应数据。 | |
| 33 | | `PhoneCodeLoginParams` | `interface` | PhoneCodeLoginParams 请求参数。 | |
| 34 | | `SendEmailCodeParams` | `interface` | SendEmailCodeParams 请求参数。 | |
| 35 | | `SendPhoneCodeParams` | `interface` | SendPhoneCodeParams 请求参数。 | |
| 36 | | `UpdateUserInfoParams` | `interface` | 更新用户信息请求参数。 | |
| 37 | |
| 38 | ## 常量清单 |
| 39 | |
| 40 | | 名称 | 类型 | 说明 | |
| 41 | | ---- | ---- | ---- | |
| 42 |