权限设置Api
# 说明
权限设置的字段请查看字段说明
# 列表查询
接口说明
根据查询条件查询权限设置列表。
接口版本
v1接口地址
/api-web-v1/general-roles
请求方法
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 | 指定关联表查询,查询多个关联表用逗号分隔 | generalRole |
请求参数举例
注意
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": 6,
"rows": [
{
"_id": "5c9c730f3b484c05528aa4db",
"name": "admin",
"sort": 1,
"desc": "admin拥有超级权限",
"createdAt": "2019-03-28T07:09:03.225Z",
"updatedAt": "2019-07-19T09:45:26.888Z",
"__v": 0
},
{
"_id": "5d9feb2f377ce1001b905b3d",
"name": "普通用户",
"sort": 3,
"desc": "注册普通用户",
"createdAt": "2019-10-11T02:38:39.672Z",
"updatedAt": "2019-10-11T06:15:37.785Z",
"__v": 0
},
{
"_id": "5dea1071e19654001bec2b0b",
"name": "子用户",
"sort": 4,
"desc": "子用户角色",
"createdAt": "2019-12-06T08:25:21.986Z",
"updatedAt": "2019-12-06T08:27:24.329Z",
"__v": 0
},
{
"_id": "5ee6ec58f584e1001dae4375",
"name": "演示用户",
"sort": 5,
"desc": "演示套件",
"createdAt": "2020-06-15T03:34:48.125Z",
"updatedAt": "2020-06-15T03:57:04.632Z",
"__v": 0
},
{
"_id": "5f23c2fdea5232001bcb144e",
"name": "水质云网用户",
"sort": 0,
"desc": "水质云网关用户",
"createdAt": "2020-07-31T07:06:37.955Z",
"updatedAt": "2020-07-31T07:06:37.955Z",
"__v": 0
},
{
"_id": "5ff6bfc4af9070001b651e01",
"name": "开发人员",
"sort": 6,
"desc": "",
"createdAt": "2021-01-07T08:01:08.739Z",
"updatedAt": "2021-01-07T08:01:08.739Z",
"__v": 0
}
]
}
}
# 新建
接口说明
新建一个权限配置。查询路由信息,勾选对应路由保存权限后再调路由中的roles-auth方法,修改路由中的权限信息
接口版本
v1接口地址
/api-v1/general-roles
请求方法
POST
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
body | - | Object | True | 路由配置对象字段说明 |
请求参数举例
{
"desc": "普通用户",
"sort": 1,
"name": "普通用户"
}
// Make sure to add code blocks to your code group
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回创建的对象 |
返回参数举例
{
"_id": "5d9feb2f377ce1001b905b3d",
"name": "普通用户",
"sort": 3,
"desc": "注册普通用户",
"createdAt": "2019-10-11T02:38:39.672Z",
"updatedAt": "2019-10-11T06:15:37.785Z",
"__v": 0
}
# 查询权限设置ID
接口说明
根据权限设置ID查询权限设置
接口版本
v1接口地址
/api-v1/general-roles/:id
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 权限设置ID |
请求参数举例
注意
GET请求所有参数类型都会拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
{
"_id": "5d9feb2f377ce1001b905b3d"
}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | false | 返回权限设置信息 |
返回参数举例
{
"code": 0,
"data": {
"_id": "5d9feb2f377ce1001b905b3d",
"name": "普通用户",
"sort": 3,
"desc": "注册普通用户",
"createdAt": "2019-10-11T02:38:39.672Z",
"updatedAt": "2019-10-11T06:15:37.785Z",
"__v": 0
}
}
# 编辑
接口说明
修改权限设置
接口版本
v1接口地址
/api-v1/general-roles/:id
请求方法
PUT
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 修改的权限设置ID |
body | - | Object | True | 权限设置对象字段说明 |
请求参数举例
{
"name": "普通用户",
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回创建的对象 |
返回参数举例
{
"code": 0,
"data": {
"_id": "5d9feb2f377ce1001b905b3d",
"name": "普通用户",
"sort": 3,
"desc": "注册普通用户",
"createdAt": "2019-10-11T02:38:39.672Z",
"updatedAt": "2019-10-11T06:15:37.785Z",
"__v": 0
}
}
上次更新: 2023/03/30, 12:02:37