Skip to content

用户模块 API 文档

用户注册接口

支持通过用户名/手机号/邮箱和密码进行用户注册

请求地址

POST http://120.27.141.109:8555/user/register

请求头(Headers)

参数名称类型是否必须默认值说明
Content-Typestringapplication/json请求体类型

请求参数(Body)

json
{
    "account": "13800138009",
    "password": "123456"
}
参数名称类型是否必须说明
accountstring用户名/手机号/邮箱
passwordstring用户密码

响应示例成功响应(200)

json
{
    "code": 200,
    "message": "成功",
    "data": {
        "user": {
            "userId": 8,
            "username": null,
            "mobile": "13800138009",
            "email": null,
            "nickname": "新用户A03685",
            "avatarUrl": null,
            "gender": null,
            "birthday": null,
            "location": null,
            "bio": null,
            "registrationTime": "2025-06-01 03:39:40",
            "lastLoginTime": "2025-06-01 03:39:40",
            "loginCount": 1,
            "isVerified": 0,
            "verificationTime": null,
            "status": 0
        },
        "token": "eyJhbGciOiJIUzI1NiJ9..."
    }
}

响应字段说明

data对象

字段名类型说明
userobject用户信息对象
tokenstring认证令牌

user对象

字段名类型说明
userIdinteger用户ID
usernamestring用户名
mobilestring手机号
emailstring邮箱
nicknamestring昵称
avatarUrlstring头像URL
genderinteger性别
birthdaystring生日
locationstring所在地
biostring个人简介
registrationTimestring注册时间
lastLoginTimestring最后登录时间
loginCountinteger登录次数
isVerifiedinteger是否已验证
verificationTimestring验证时间
statusinteger账号状态

cURL请求示例

bash
curl --location --request POST 'http://120.27.141.109:8555/user/register' \
--header 'Authorization: eyJhbGciOiJIUzI1NiJ9...' \
--header 'Content-Type: application/json' \
--data-raw '{
    "account": "13800138009",
    "password": "123456"
}'

注意事项

  1. 账号(account)字段支持用户名、手机号或邮箱
  2. 成功注册后会返回用户信息和认证token
  3. 认证token需要妥善保存,用于后续接口调用

用户登录接口

支持通过用户名/手机号/邮箱与密码进行登录

请求地址

POST http://120.27.141.109:8555/user/login

请求头(Headers)

参数名称类型是否必须默认值说明
Content-Typestringapplication/json请求体类型

请求参数(Body)

json
{
    "account": "13800138009",
    "password": "123456"
}
参数名称类型是否必须说明
accountstring用户名/手机号/邮箱
passwordstring用户密码

响应示例

与注册接口响应结构相同


获取用户信息接口

获取当前登录用户的详细信息

请求地址

GET http://120.27.141.109:8555/user/info

请求头(Headers)

参数名称类型是否必须默认值说明
Content-Typestringapplication/json请求体类型
Authorizationstring-用户认证token

请求参数(Query)

参数名称类型是否必须说明
fieldsstring指定返回字段,多个用逗号分隔

响应示例成功响应(200)

json
{
    "code": 200,
    "message": "成功",
    "data": {
        "userId": 8,
        "username": null,
        "mobile": "138****8009",
        "email": null,
        "nickname": "新用户A03685",
        "avatarUrl": "https://thirdwx.qlogo.cn/mmopen/vi_32/...",
        "gender": 1,
        "birthday": "1990-01-01",
        "location": "广东省深圳市",
        "bio": "这个人很懒,什么都没留下",
        "registrationTime": "2025-06-01 03:39:40",
        "lastLoginTime": "2025-06-01 03:39:40",
        "loginCount": 5,
        "isVerified": 1,
        "verificationTime": "2025-06-01 03:40:00",
        "status": 0,
        "permissions": ["user", "vip"],
        "settings": {
            "notification": true,
            "theme": "light"
        }
    }
}

响应字段说明

字段名类型说明
userIdinteger用户ID
usernamestring用户名
mobilestring手机号(脱敏)
emailstring邮箱
nicknamestring昵称
avatarUrlstring头像URL
genderinteger性别(0女,1男)
birthdaystring生日
locationstring所在地
biostring个人简介
registrationTimestring注册时间
lastLoginTimestring最后登录时间
loginCountinteger登录次数
isVerifiedinteger是否已验证(0否1是)
verificationTimestring验证时间
statusinteger账号状态(0正常1禁用)
permissionsarray权限列表
settingsobject用户设置

cURL请求示例

bash
curl --location --request GET 'http://120.27.141.109:8555/user/info?fields=nickname,mobile,avatarUrl' \
--header 'Authorization: eyJhbGciOiJIUzI1NiJ9...' \
--header 'Content-Type: application/json'

错误响应

1. 未登录或token无效(401)

json
{
    "code": 401,
    "message": "未登录或登录已过期",
    "data": null
}

2. 用户不存在(404)

json
{
    "code": 404,
    "message": "用户不存在",
    "data": null
}

注意事项

  1. 调用此接口需要先登录并在请求头中携带有效的token
  2. 手机号等敏感信息会进行脱敏处理
  3. 可通过fields参数指定需要返回的字段,减少数据传输量
  4. 接口调用频率限制为每分钟30次
  5. 返回的权限列表(permissions)决定了用户可以访问的功能

基于 MIT 许可发布