用户模块
文档所属项目:花枫咖啡馆Internal API文档 (/wiki/flowermaplechatapi)
内部扩展 API — 用户模块 (User)
基础信息
- 前缀URL:
/v1/internal/user - 主要功能: 获取当前用户信息与在线状态、全站搜索用户、平台总用户数统计、修改个人资料。
接口列表
1. 获取当前用户信息及状态
POST /v1/internal/user/me
获取当前登录用户的完整个人资料及在线状态。需 Header 携带 Token。
请求参数 无
成功响应示例
{
"id": 1,
"username": "zhangsan",
"email": "zhangsan@example.com",
"avatar_url": "https://example.com/avatar.jpg",
"is_bot": false,
"email_verified": true,
"created_at": "2026-01-01 00:00:00",
"is_online": true
}
2. 搜索用户
POST /v1/internal/user/search
根据关键字搜索用户列表。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| query | string | 是 | 搜索关键字(匹配用户名或邮箱) |
| limit | number | 否 | 返回数量限制,默认 20 |
请求示例
{
"query": "zhang",
"limit": 10
}
成功响应示例
{
"data": [
{
"id": 1,
"username": "zhangsan",
"avatar_url": "https://example.com/avatar.jpg",
"is_bot": false
}
]
}
3. 获取用户总数统计
POST /v1/internal/user/stats
获取平台注册用户总量。
请求参数 无
成功响应示例
{
"total_users": 150
}
4. 更新个人资料
POST /v1/internal/user/profile/update
修改当前登录用户的个人资料(用户名或头像)。需 Header 携带 Token。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| username | string | 否 | 新用户名 |
| avatar_url | string | 否 | 新头像 URL |
请求示例
{
"username": "zhangsan_new",
"avatar_url": "https://example.com/new_avatar.jpg"
}
成功响应示例
{
"success": true
}
