zhibo/模块文档/01-用户系统模块.md
2025-12-30 11:11:11 +08:00

2.4 KiB

用户系统模块接口文档

模块概述

用户系统模块提供用户注册、登录、资料管理等基础功能。


接口列表

1. 账号密码登录

接口路径: POST /api/front/login

请求参数:

{
  "account": "手机号",
  "password": "密码"
}

返回参数:

{
  "code": 200,
  "msg": "success",
  "data": {
    "token": "JWT令牌",
    "uid": 用户ID,
    "nikeName": "昵称",
    "phone": "手机号"
  }
}

2. APP用户注册

接口路径: POST /api/front/register

请求参数:

{
  "phone": "手机号",
  "password": "密码",
  "verificationCode": "验证码(可选)",
  "nickname": "昵称(可选)"
}

返回参数:

{
  "code": 200,
  "msg": "success",
  "data": {
    "token": "JWT令牌",
    "uid": 用户ID,
    "nikeName": "昵称",
    "phone": "手机号"
  }
}

3. 发送短信验证码

接口路径: POST /api/front/sendCode

请求参数:

phone=手机号 (FormUrlEncoded格式)

返回参数:

{
  "code": 200,
  "msg": "发送成功"
}

4. 获取用户信息

接口路径: GET /api/front/user

请求头:

Authorization: Bearer {token}

请求参数: 无

返回参数:

{
  "code": 200,
  "msg": "success",
  "data": {
    "uid": 用户ID,
    "nickname": "昵称",
    "avatar": "头像URL",
    "phone": "手机号",
    "balance": 余额,
    "integral": 积分,
    "experience": 经验值,
    "level": 等级
  }
}

5. 更新用户资料

接口路径: POST /api/front/user/edit

请求头:

Authorization: Bearer {token}

请求参数:

{
  "nickname": "昵称",
  "avatar": "头像URL"
}

返回参数:

{
  "code": 200,
  "msg": "success"
}

6. 上传头像

接口路径: POST /api/front/user/upload/image

请求头:

Authorization: Bearer {token}
Content-Type: multipart/form-data

请求参数:

file: 图片文件
model: "user"
pid: 7

返回参数:

{
  "code": 200,
  "msg": "success",
  "data": {
    "url": "图片URL",
    "name": "文件名",
    "size": 文件大小
  }
}

7. 退出登录

接口路径: GET /api/front/logout

请求头:

Authorization: Bearer {token}

请求参数: 无

返回参数:

{
  "code": 200,
  "msg": "success"
}