用户信息Api
# 说明
用户信息的字段请查看字段说明
# 列表查询
接口说明
根据查询条件查询用户信息列表。
接口版本
v1接口地址
/api-web-v1/users
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 | 默认 | 示例 |
---|---|---|---|---|---|---|
query | label | string | false | 模糊查询字段 | name | |
query | search | string | false | 模糊查询值 | 测试 | |
query | time | string | false | 时间范围查询字段,必须是用户信息字段中的时间或时间戳字段名,例如createdAt,updatedAt | createdAt | |
query | range | string[] or string | false | 时间范围,开始时间到结束时间,可以是string[]或者以逗号分割的开始时间到结束时间或时间戳 | 2019-10-22T00:00:00.000Z,2022-01-22T00:00:00.000Z | |
query | page | number | false | 分页第几页 | 1 | |
query | limit | number | false | 单页几条数据 | 10 | |
query | sort | string | false | 根据哪个字段排序 | _id | -createdAt |
query | select | string | false | 只查询部分字段,字段名之间用过空格分隔,去掉某个字段的查询字段名前面加- | ||
query | autopopulate | boolean | false | 自动关联数据,部分字段自动关联关系表查询,设置这个值可开关自动联表查询 | true | false |
query | populate | string | false | 指定关联表查询,查询多个关联表用逗号分隔 | control |
请求参数举例
注意
GET请求所有参数类型都会变成string拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
{
"page":"1",
"limit":"10",
"sort":"-createdAt",
"autopopulate":"false"
}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回数据 |
-total | number | False | 用户信息总条数 |
-rows | array | False | 当前返回的用户信息对象列表 |
返回参数举例
{
"code": 0,
"data": {
"total": 1,
"rows": [
{
"email": "wangbinbin@qq.com",
"mqttPassword": "88223080",
"cloudType": true,
"avatar": "/images/user.gif",
"roles": [
{
"_id": "5d9feb2f377ce1001b905b3d",
"name": "普通用户",
"sort": 3,
"desc": "注册普通用户",
"createdAt": "2019-10-11T02:38:39.672Z",
"updatedAt": "2019-10-11T06:15:37.785Z",
"__v": 0
}
],
"smsCloud": false,
"type": 0,
"children": [],
"displayAreaClass": [],
"dataShowBoard": [],
"controlIds": [],
"controlUserIds": [],
"httpDrives": [],
"status": true,
"_id": "5da855b71816bc001be72f4b",
"trueName": "王宾宾",
"username": "15258284638",
"mqttUsername": "15258284638",
"mqttRole": "5d908b44a79b4f66c55c5201",
"createdAt": "2019-10-17T11:51:19.104Z",
"updatedAt": "2020-08-21T03:02:20.026Z",
"__v": 5,
"smsNumber": 100
}
]
}
}
# 查询用户信息ID
接口说明
根据用户信息ID查询用户信息
接口版本
v1接口地址
/api-v1/users/:id
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 用户信息ID |
请求参数举例
注意
GET请求所有参数类型都会拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
{
"_id": "5da855b71816bc001be72f4b"
}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | false | 返回用户信息信息 |
返回参数举例
{
"code": 0,
"data": {
"email": "wangbinbin@qq.com",
"mqttPassword": "88223080",
"cloudType": true,
"avatar": "/images/user.gif",
"roles": [
{
"_id": "5d9feb2f377ce1001b905b3d",
"name": "普通用户",
"sort": 3,
"desc": "注册普通用户",
"createdAt": "2019-10-11T02:38:39.672Z",
"updatedAt": "2019-10-11T06:15:37.785Z",
"__v": 0
}
],
"generalRoles":[],
"smsCloud": false,
"type": 0,
"children": [],
"displayAreaClass": [],
"dataShowBoard": [],
"controlIds": [],
"controlUserIds": [],
"httpDrives": [],
"status": true,
"_id": "5da855b71816bc001be72f4b",
"trueName": "王宾宾",
"username": "15258284638",
"mqttUsername": "15258284638",
"mqttRole": "5d908b44a79b4f66c55c5201",
"createdAt": "2019-10-17T11:51:19.104Z",
"updatedAt": "2020-08-21T03:02:20.026Z",
"__v": 5,
"smsNumber": 100
}
}
# 新建
接口说明
新建一个用户信息。
接口版本
v1接口地址
/api-v1/users
请求方法
POST
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
body | - | Object | True | 用户信息对象字段说明 |
请求参数举例
{
"email": "wangbinbin@qq.com",
"cloudType": true,
"avatar": "/images/user.gif",
"roles": ["5d9feb2f377ce1001b905b3d"],
"smsCloud": false,
"type": 0,
"status": true,
"trueName": "王宾宾",
"username": "15258284638",
"mqttUsername": "15258284638",
"mqttPassword": "88223080",
"mqttRole": "5d908b44a79b4f66c55c5201",
"smsNumber": 100
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回创建的对象 |
返回参数举例
{
"email": "wangbinbin@qq.com",
"mqttPassword": "88223080",
"cloudType": true,
"avatar": "/images/user.gif",
"roles": ["5d9feb2f377ce1001b905b3d"],
"smsCloud": false,
"type": 0,
"status": true,
"_id": "5da855b71816bc001be72f4b",
"trueName": "王宾宾",
"username": "15258284638",
"mqttUsername": "15258284638",
"mqttRole": "5d908b44a79b4f66c55c5201",
"createdAt": "2019-10-17T11:51:19.104Z",
"updatedAt": "2020-08-21T03:02:20.026Z",
"smsNumber": 100
}
# 注册
接口说明
注册一个用户信息。
接口版本
v1接口地址
/api-v1/auth/register
请求方法
POST
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
body | - | Object | True | 用户信息对象字段说明 |
- | String | False | 邮箱 | |
-trueName | - | String | False | 名称 |
-username | - | String | False | 用户名 |
-password | - | String | False | 密码 |
请求参数举例
{
"email": "wangbinbin@qq.com",
"trueName": "王宾宾",
"username": "15258284638"
"password": "123456"
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回提示 |
返回参数举例
{
"code": 0,
"data": {
"email": "wangbinbin@qq.com",
"cloudType": true,
"avatar": "/images/user.gif",
"roles": ["5d9feb2f377ce1001b905b3d"],
"smsCloud": false,
"type": 0,
"status": false,
"_id": "5da855b71816bc001be72f4b",
"trueName": "王宾宾2",
"username": "15258284638",
"mqttUsername": "15258284638",
"mqttRole": "5d908b44a79b4f66c55c5201",
"createdAt": "2019-10-17T11:51:19.104Z",
"updatedAt": "2020-08-21T03:02:20.026Z",
"smsNumber": 100,
"verifyType":0
}
}
# 编辑
接口说明
修改用户信息。取消任务
接口版本
v1接口地址
/api-v1/users/:id
请求方法
PUT
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 修改的用户信息ID |
body | - | Object | True | 用户信息对象字段说明 |
请求参数举例
{
"trueName": "王宾宾2",
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回创建的对象 |
返回参数举例
{
"code": 0,
"data": {
"email": "wangbinbin@qq.com",
"mqttPassword": "88223080",
"cloudType": true,
"avatar": "/images/user.gif",
"roles": ["5d9feb2f377ce1001b905b3d"],
"smsCloud": false,
"type": 0,
"status": true,
"_id": "5da855b71816bc001be72f4b",
"trueName": "王宾宾2",
"username": "15258284638",
"mqttUsername": "15258284638",
"mqttRole": "5d908b44a79b4f66c55c5201",
"createdAt": "2019-10-17T11:51:19.104Z",
"updatedAt": "2020-08-21T03:02:20.026Z",
"smsNumber": 100
}
}
# 删除
接口说明
删除一个用户信息。
接口版本
v1接口地址
/api-v1/users/:id
请求方法
DELETE
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 删除的用户信息ID |
请求参数举例
只需发送删除用户信息的ID
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
message | string | false | 成功删除返回complete |
返回参数举例
{
"code": 0,
"message": "complete"
}
此接口需实际用户信息。文档不提供删除在线调试
# 审核
接口说明
审核一个用户信息。
接口版本
v1接口地址
/api-v1/users/verify-user
请求方法
POST
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
body | - | Object | True | 用户信息对象字段说明 |
-_id | - | ObjectId | False | 用户Id |
-verifyType | - | Number | False | 审核状态 0:待审核 1:确认 2:拒绝 |
请求参数举例
{
"_id": "5da855b71816bc001be72f4b",
"verifyType": 1
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回提示 |
返回参数举例
{ code: 0,
data: { message: '审核通过' }
}
上次更新: 2023/05/19, 16:49:26