zhuzihao
d8c7a6d1ef
Co-authored-by: zzhyyyyy <2685922758@qq.com> Reviewed-on: #69 Co-authored-by: zhuzihao <zhuzihao@wonderable.ai> Co-committed-by: zhuzihao <zhuzihao@wonderable.ai>
101 lines
3.3 KiB
Python
101 lines
3.3 KiB
Python
"""Auth 相关请求 / 响应 schemas。
|
|
|
|
跟客户端约定:
|
|
- 字段统一用 snake_case
|
|
- 时间字段统一 ISO 8601 (UTC)
|
|
- 登录类接口成功时统一返回 TokenWithUser
|
|
"""
|
|
from __future__ import annotations
|
|
|
|
from datetime import datetime
|
|
|
|
from pydantic import BaseModel, ConfigDict, Field
|
|
|
|
|
|
# ===== 用户对外信息 =====
|
|
|
|
class UserOut(BaseModel):
|
|
model_config = ConfigDict(from_attributes=True) # 允许直接 UserOut.model_validate(orm_user)
|
|
|
|
id: int
|
|
# 对外展示的账号 ID:11 位纯数字、首位非 1、全局唯一、创建时分配、不可变。区别于登录用的 phone。
|
|
username: str
|
|
phone: str
|
|
nickname: str | None = None
|
|
avatar_url: str | None = None
|
|
register_channel: str
|
|
status: str
|
|
created_at: datetime
|
|
last_login_at: datetime
|
|
# 调试链接权限:前端据此在比价结果弹窗/记录页显示「复制调试链接」按钮。默认 false。
|
|
debug_trace_enabled: bool = False
|
|
|
|
|
|
# ===== Token 通用结构 =====
|
|
|
|
class TokenPair(BaseModel):
|
|
access_token: str
|
|
refresh_token: str
|
|
token_type: str = "Bearer"
|
|
expires_in: int = Field(..., description="access_token 剩余秒数")
|
|
refresh_expires_in: int = Field(..., description="refresh_token 剩余秒数")
|
|
|
|
|
|
class TokenWithUser(TokenPair):
|
|
user: UserOut
|
|
onboarding_completed: bool = Field(
|
|
False,
|
|
description="该 设备+账号 是否已走完新手引导(据登录请求里的 device_id 计算)。"
|
|
"true → 客户端登录后直接进首页,跳过引导。",
|
|
)
|
|
force_onboarding: bool = Field(
|
|
False,
|
|
description="是否强制本次登录走新手引导(仅测试号置 true)。客户端据此让【应用内重新登录】"
|
|
"(退出后再登)也重走引导,普通号为 false、按原逻辑回原页/首页。与 onboarding_completed "
|
|
"分工:后者管 App 启动路由,本字段管应用内登录后的去向。",
|
|
)
|
|
|
|
|
|
# ===== 极光一键登录 =====
|
|
|
|
class JverifyLoginRequest(BaseModel):
|
|
login_token: str = Field(..., description="客户端 loginAuth 拿到的 loginToken", min_length=1)
|
|
operator: str = Field("", description="CM/CU/CT,用于日志,可选")
|
|
device_id: str = Field(
|
|
"", max_length=64,
|
|
description="硬件级设备标识(Android ANDROID_ID),用于新手引导按 设备+账号 去重;空=按未完成处理",
|
|
)
|
|
|
|
|
|
# ===== 短信验证码 =====
|
|
|
|
class SmsSendRequest(BaseModel):
|
|
phone: str = Field(..., min_length=11, max_length=11, pattern=r"^1\d{10}$")
|
|
|
|
|
|
class SmsSendResponse(BaseModel):
|
|
sent: bool
|
|
mock: bool = Field(..., description="是否 mock 发送(true 时验证码不会真发,任意 6 位通过)")
|
|
cooldown_sec: int = Field(..., description="多少秒后才能再发一次")
|
|
|
|
|
|
class SmsLoginRequest(BaseModel):
|
|
phone: str = Field(..., min_length=11, max_length=11, pattern=r"^1\d{10}$")
|
|
code: str = Field(..., min_length=4, max_length=8)
|
|
device_id: str = Field(
|
|
"", max_length=64,
|
|
description="硬件级设备标识(Android ANDROID_ID),用于新手引导按 设备+账号 去重;空=按未完成处理",
|
|
)
|
|
|
|
|
|
# ===== Refresh =====
|
|
|
|
class RefreshRequest(BaseModel):
|
|
refresh_token: str = Field(..., min_length=1)
|
|
|
|
|
|
# ===== Logout =====
|
|
|
|
class LogoutResponse(BaseModel):
|
|
ok: bool = True
|