查询用户列表(分页)

请求信息

请求地址

http://127.0.0.1:7086/api/v1/user/queryUsers

请求方法

POST

请求体类型

application/x-www-form-urlencoded

入参

入参示例 (Postman Bulk Edit)

pageNumber:1
pageSize:20
//searchKeyword:模糊搜索词
//gender:2
//ageStart:1
//ageEnd:1
//registerTimeStart:2022-05-09
//registerTimeEnd:2022-05-09

入参字段说明

字段 类型 必填 含义 其他参考信息
pageNumber
Integer

分页-当前页码 示例值为 1
pageSize
Integer

分页-分页大小 示例值为 20
searchKeyword
String

模糊搜索词
支持用户昵称, 用户姓名, 用户手机号

gender
Integer

用户性别
0: 保密
1: 男
2: 女
示例值为 2
ageStart
Integer

过滤年龄范围-起始
ageEnd
Integer

过滤年龄范围-结束
registerTimeStart
String

注册时间范围-开始
格式: 2022-05-09
示例值为 2022-05-09
registerTimeEnd
Date

注册时间范围-结束
格式: 2022-05-09
示例值为 2022-05-09

出参

出参示例

{
  "success": true,
  "code": 200,
  "message": "错误信息",
  "data": [
    {
      "userId": 10,
      "userNickName": "用户昵称",
      "userRealName": "用户姓名",
      "userGender": 2,
      "userAge": 18,
      "userPhone": "13123339966",
      "userEmail": "2333@163.com",
      "userAvatar": "https://img.xxx.com/xxxxxxx"
    },
    {
      "userId": 10,
      "userNickName": "用户昵称",
      "userRealName": "用户姓名",
      "userGender": 2,
      "userAge": 18,
      "userPhone": "13123339966",
      "userEmail": "2333@163.com",
      "userAvatar": "https://img.xxx.com/xxxxxxx"
    }
  ],
  "totalCount": 10
}

出参字段说明

字段 类型
含义 其他参考信息
success
Boolean
请求是否成功 示例值为 true
code
Integer
状态码
200: 代表成功
其它代表异常
示例值为 200
message
String
错误信息
data
List<UserResponse>
返回数据
└─ userId
Long
用户ID-主键
└─ userNickName
String
用户昵称
└─ userRealName
String
用户姓名
└─ userGender
Integer
用户性别
0:保密
1:男
2:女
示例值为 2
└─ userAge
Integer
用户年龄 示例值为 18
└─ userPhone
String
联系方式-手机号 示例值为 13123339966
└─ userEmail
String
联系方式-电子邮箱 示例值为 2333@163.com
└─ userAvatar
String
用户头像 url 地址 示例值为 https://img.xxx.com/xxxxxxx
totalCount
Long
分页-总条数

新增一个用户

请求信息

请求地址

http://127.0.0.1:7086/api/v1/user/createUser

请求方法

POST

请求体类型

application/x-www-form-urlencoded

入参

入参示例 (Postman Bulk Edit)

userNickName:用户昵称
userRealName:用户姓名
userGender:2
//userAge:18
//userPhone:联系方式-手机号
//userEmail:联系方式-电子邮箱
//userAvatar:用户头像 url 地址

入参字段说明

字段 类型 必填 含义 其他参考信息
userNickName
String

用户昵称 用户昵称需唯一
userRealName
String

用户姓名
userGender
Integer

用户性别
0:保密
1:男
2:女
示例值为 2
userAge
Integer

用户年龄 示例值为 18
userPhone
String

联系方式-手机号
userEmail
String

联系方式-电子邮箱
userAvatar
String

用户头像 url 地址

出参

出参示例

{
  "success": true,
  "code": 200,
  "message": "错误信息",
  "data": false
}

出参字段说明

字段 类型
含义 其他参考信息
success
Boolean
请求是否成功 示例值为 true
code
Integer
状态码
200: 代表成功
其它代表异常
示例值为 200
message
String
错误信息
data
Boolean
返回数据

更多信息

Code 更多含义

Code 含义
10001 用户昵称已存在
10002 用户年龄范围无效 用户年龄需在0~200之间的数字

更新一个用户

请求信息

请求地址

http://127.0.0.1:7086/api/v1/user/updateUser

请求方法

POST

请求体类型

application/x-www-form-urlencoded

入参

入参示例 (Postman Bulk Edit)

userId:10
userRealName:用户姓名
userGender:2
//userAge:18
//userPhone:联系方式-手机号
//userEmail:联系方式-电子邮箱
//userAvatar:用户头像 url 地址

入参字段说明

字段 类型 必填 含义 其他参考信息
userId
Long

用户ID 主键
userRealName
String

用户姓名
userGender
Integer

用户性别
0:保密
1:男
2:女
示例值为 2
userAge
Integer

用户年龄 示例值为 18
userPhone
String

联系方式-手机号
userEmail
String

联系方式-电子邮箱
userAvatar
String

用户头像 url 地址

出参

出参示例

{
  "success": true,
  "code": 200,
  "message": "错误信息",
  "data": false
}

出参字段说明

字段 类型
含义 其他参考信息
success
Boolean
请求是否成功 示例值为 true
code
Integer
状态码
200: 代表成功
其它代表异常
示例值为 200
message
String
错误信息
data
Boolean
返回数据

更多信息

Code 更多含义

Code 含义
10002 用户年龄范围无效 用户年龄需在0~200之间的数字

删除一个用户

请求信息

请求地址

http://127.0.0.1:7086/api/v1/user/deleteUser

请求方法

POST

请求体类型

application/x-www-form-urlencoded

入参

入参示例 (Postman Bulk Edit)

userId:1

入参字段说明

字段 类型 必填 含义 其他参考信息
userId
Long

用户ID 示例值为 1

出参

出参示例

{
  "success": true,
  "code": 200,
  "message": "错误信息",
  "data": false
}

出参字段说明

字段 类型
含义 其他参考信息
success
Boolean
请求是否成功 示例值为 true
code
Integer
状态码
200: 代表成功
其它代表异常
示例值为 200
message
String
错误信息
data
Boolean
返回数据

更多信息

Code 更多含义

Code 含义
10003 用户信息不存在