docs(api): 同步 API 文档与实际实现一致
README.md: - 开发环境端口 8080 → 8085 - 统一响应格式添加 trace_id 字段 - 成功消息 "ok" → "success",创建 "created" frontend/auth.md(全面更新): - 注册响应:201 状态码 + message="created" + expires_in=7200 - 所有响应示例:添加 trace_id 和 time 字段 - user 对象:添加 gender 字段 - 退出登录:更新为无状态 JWT 说明(非 Redis) - 刷新 Token:添加 user 字段到响应 - profile:添加 phone + created_at 字段 - 错误码:统一使用 HTTP 状态码说明表 代码同步: - dto.UserInfo: 添加 Phone + CreatedAt 字段 - auth_service.buildUserInfo: 填充新字段 Made-with: Cursor
This commit is contained in:
@@ -41,7 +41,7 @@
|
||||
|
||||
| 环境 | 地址 |
|
||||
|------|------|
|
||||
| 开发环境 | `http://localhost:8080` |
|
||||
| 开发环境 | `http://localhost:8085` |
|
||||
| 生产环境 | `https://api.echochat.com`(待定) |
|
||||
|
||||
### 认证方式
|
||||
@@ -73,8 +73,20 @@ yyyy-MM-dd HH:mm:ss
|
||||
```json
|
||||
{
|
||||
"code": 0,
|
||||
"message": "ok",
|
||||
"message": "success",
|
||||
"data": { ... },
|
||||
"trace_id": "6478824e-2926-4d35-aa5f-047c8cfbb36b",
|
||||
"time": "2026-02-27 18:00:00"
|
||||
}
|
||||
```
|
||||
|
||||
**创建成功响应(如注册):**
|
||||
```json
|
||||
{
|
||||
"code": 0,
|
||||
"message": "created",
|
||||
"data": { ... },
|
||||
"trace_id": "6478824e-2926-4d35-aa5f-047c8cfbb36b",
|
||||
"time": "2026-02-27 18:00:00"
|
||||
}
|
||||
```
|
||||
@@ -84,11 +96,13 @@ yyyy-MM-dd HH:mm:ss
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "参数错误:邮箱格式不正确",
|
||||
"data": null,
|
||||
"trace_id": "66564073-c0b7-4cf6-a200-5df94e1d01f3",
|
||||
"time": "2026-02-27 18:00:00"
|
||||
}
|
||||
```
|
||||
|
||||
> **trace_id** 字段在所有响应中都返回,用于追踪同一请求在各层级日志中的关联。
|
||||
|
||||
### 错误码定义
|
||||
|
||||
#### 通用错误码(1000-1099)
|
||||
|
||||
Reference in New Issue
Block a user