用户模块接口文档

一、用户注册

1、基本信息：

请求路径：/user/register
请求方式：POST
接口描述：该接口用于用户通过手机号注册账号

2、请求参数：
请求参数格式：application/x-www-form-urlencoded

参数名称	说明	类型	是否必须	备注
phone	手机号码	String	是	必须输入11位
password	登录密码	String	是	必须5-16位

3、请求样例：

{
  “phone”: "12345678901"
  “password”： “123456”
}

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称	类型	是否必须	默认值	备注	其他信息
code	number	是		响应码，0-成功，1-失败
message	String	否		提示信息
data	String	否		返回的数据

响应数据样例：

{
    "code": 1,
    "massage": "该手机号已注册",
    "data": null
}

{
    "code": 0,
    "massage": "操作成功",
    "data": "当前时间： 19:11:30.229368700 来自于 MiniShopping "
}

二、用户登录

1、基本信息：

请求路径：/user/login
请求方式：POST
接口描述：该接口用于用户通过手机号登录账号

2、请求参数：
请求参数格式：application/x-www-form-urlencoded

参数名称	说明	类型	是否必须	备注
phone	手机号码	String	是	必须输入11位
password	登录密码	String	是	必须5-16位

3、请求样例：

{
  “phone”: "12345678901"
  “password”： “123456”
}

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称	类型	是否必须	默认值	备注	其他信息
code	number	是		响应码，0-成功，1-失败
message	String	否		提示信息
data	String	否		返回的数据是JWT令牌，需要客户端保存该令牌，后续请求进行附带作为已登录标志同时验证身份	JWT令牌申请后一个小时自动过期

响应数据样例：

{
    "code": 1,
    "massage": "该手机号未注册",
    "data": null
}

{
    "code": 1,
    "massage": "密码错误",
    "data": null
}

{
    "code": 0,
    "massage": "操作成功",
    "data": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGFpbXMiOnsicGhvbmUiOiIxMjM0NTY3ODkwNyIsImlkIjo2fSwiZXhwIjoxNzMxNzEyNzIxfQ.suxQYM1Byw8p6WV7xCb-cbvkMcLYKw5EA2kO8gnMzlA"
}

三、获取用户基本信息

1、基本信息：

请求路径：/user/userInfo
请求方式：GET
接口描述：该接口用于用户获取基本信息

2、请求参数：无，但需要将登录时下发的JWT令牌附带于请求头header中，请求头名称为Authorization,值为JWT令牌(除了注册以及登录之外，访问其它接口都需要这个请求头)
请求格式：applicaytion/json

3、请求样例：无

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称	类型	是否必须	默认值	备注	其他信息
code	number	是		响应码，0-成功，1-失败
message	String	否		提示信息
data	Object	是		返回的数据

响应数据样例：

{
    "code": 0,
    "massage": "操作成功",
    "data": {
        "id": 2,
        "phone": "12345678903",
        "nickname": "",
        "gender": "",
        "user_pic": "",
        "address": "",
        "email": "",
        "cart":"",
        "create_time": "2024-11-15T01:53:47",
        "update_time": "2024-11-15T01:53:47"
    }
}

四、更新用户基本信息

1、基本信息：

请求路径：/user/update
请求方式：PUT
接口描述：该接口用于用户更新不重要信息（除了id，手机号，头像和密码）

2、请求参数：
请求参数格式：applocation/json

参数名称	说明	类型	是否必须	备注
id	主键ID	number	是	用于验证身份，在该接口无法修改
phone	手机号	String	是	用于验证身份，在该接口无法修改
nickname	昵称	String	否
gender	性别	String	否
address	地址	String	否
email	邮箱	String	否	非空时需要满足电子邮箱格式

3、请求样例：

{
    "id": 2,
    "phone": "12345678901",
    "nickname": "",
    "gender": "男",
    "user_pic": "",
    "address": "",
    "email": ""
}

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称	类型	是否必须	默认值	备注	其他信息
code	number	是		响应码，0-成功，1-失败
message	String	否		提示信息
data	String	否		返回的数据

响应数据样例：

{
    "code": 0,
    "massage": "操作成功",
    "data": "更新成功"
}

五、更新用户头像

1、基本信息：

请求路径：/user/updateAvatar
请求方式：PATCH
接口描述：该接口用于用户更新头像

2、请求参数：
请求参数格式：params

参数名称	说明	类型	是否必须	备注
avatarUrl	头像	String	是	url地址

3、请求样例：

？avatarUrl=https://gd-hbimg.huaban.com/e31c65d6e91f54ebc43af8cdf5bbbe27ea94d958452b-I06IS4_fw658

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称	类型	是否必须	默认值	备注	其他信息
code	number	是		响应码，0-成功，1-失败
message	String	否		提示信息
data	String	否		返回的数据

响应数据样例：

{
    "code": 0,
    "massage": "操作成功",
    "data": "更新成功"
}

六、更新用户密码

1、基本信息：

请求路径：/user/updatePwd
请求方式：PATCH
接口描述：该接口用于用户更新密码

2、请求参数：
请求参数格式：applocation/json

参数名称	说明	类型	是否必须	备注
old_pwd	原密码	String	是	必须5-16位
new_pwd	新密码	String	是	必须5-16位
re_pwd	再次输入的密码	String	是	必须5-16位

3、请求样例：

{
    "old_pwd":"654321",
    "new_pwd":"123456",
    "re_pwd":"123456"
}

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称	类型	是否必须	默认值	备注	其他信息
code	number	是		响应码，0-成功，1-失败
message	String	否		提示信息
data	String	否		返回的数据

响应数据样例：

{
    "code": 0,
    "massage": "操作成功",
    "data": "更新成功"
}

七、更新用户绑定手机号

1、基本信息：

请求路径：/user/updatePhone
请求方式：PATCH
接口描述：该接口用于用户更新手机号

2、请求参数：
请求参数格式：application/x-www-form-urlencoded

参数名称	说明	类型	是否必须	备注
phone	新手机号	String	是	必须11位

3、请求样例：

'12345678905'

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称	类型	是否必须	默认值	备注	其他信息
code	number	是		响应码，0-成功，1-失败
message	String	否		提示信息
data	String	否		返回的数据

响应数据样例：

{
    "code": 0,
    "massage": "操作成功",
    "data": "更新成功"
}

八、更新用户购物车

1、基本信息：

请求路径：/product/cart
请求方式：PUT
接口描述：该接口用于用户更新数据库中的购物车

2、请求参数：
请求参数格式：applocation/json

参数名称	说明	类型	是否必须	备注
list	购物车所有商品id值列表	number数组	是

3、请求样例：

{
    "list":[12,1,1,4,7,9]
}

4、响应数据：
响应类型：applicaytion/json
响应参数说明：

参数名称	类型	是否必须	默认值	备注	其他信息
code	number	是		响应码，0-成功，1-失败
message	String	否		提示信息
data	String	否		返回的数据

响应数据样例：

{
    "code": 0,
    "massage": "操作成功",
    "data": "当前时间： 02:56:11.104762400 来自于 MiniShopping "
}