路由Api
# 说明
路由的字段请查看字段说明
# 列表查询
接口说明
根据查询条件查询路由列表。
接口版本
v1接口地址
/api-web-v1/general-routers
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 | 默认 | 示例 |
---|---|---|---|---|---|---|
query | label | string | false | 模糊查询字段 | name | |
query | search | string | false | 模糊查询值 | 1765181758@qq.com | |
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": [
{
"children": [],
"roles": [
{
"_id": "5d9feb2f377ce1001b905b3d",
"name": "普通用户",
"sort": 3,
"desc": "注册普通用户",
"createdAt": "2019-10-11T02:38:39.672Z",
"updatedAt": "2019-10-11T06:15:37.785Z",
"__v": 0
}
],
"_id": "5fabac0ca4475c001bd34670",
"name": "测试路由",
"keepAlive":true,
"showLink":true,
"redirect": "",
"icon":"el-icon",
"createdAt": "2020-11-11T09:17:00.604Z",
"updatedAt": "2022-07-12T10:12:34.778Z",
"path": "server",
"sort": 1
}
]
}
}
# 新建
接口说明
新建一个路由配置。如需将路由设置成某一子路由,将当前路由的_id 放置在父级的children[]中并更新父级路由
接口版本
v1接口地址
/api-v1/general-routers
请求方法
POST
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
body | - | Object | True | 路由配置对象字段说明 |
请求参数举例
{
"name": "测试路由",
"keepAlive":true,
"showLink":true,
"redirect": "",
"icon":"el-icon",
"path": "server",
"sort": 1
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回创建的对象 |
返回参数举例
{
"children": [],
"roles": [],
"_id": "5fabac0ca4475c001bd34670",
"name": "测试路由",
"keepAlive":true,
"showLink":true,
"redirect": "",
"icon":"el-icon",
"createdAt": "2020-11-11T09:17:00.604Z",
"updatedAt": "2022-07-12T10:12:34.778Z",
"path": "server",
"sort": 1
}
# 查询路由ID
接口说明
根据路由ID查询路由
接口版本
v1接口地址
/api-v1/general-routers/:id
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 路由id |
请求参数举例
注意
GET请求所有参数类型都会拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
{
"_id": "5fabac0ca4475c001bd34670"
}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | false | 返回路由信息 |
返回参数举例
{
"code": 0,
"data": {
"children": [],
"roles": [
{
"_id": "5d9feb2f377ce1001b905b3d",
"name": "普通用户",
"sort": 3,
"desc": "注册普通用户",
"createdAt": "2019-10-11T02:38:39.672Z",
"updatedAt": "2019-10-11T06:15:37.785Z",
"__v": 0
}
],
"_id": "5fabac0ca4475c001bd34670",
"name": "测试路由",
"keepAlive":true,
"showLink":true,
"redirect": "",
"icon":"el-icon",
"createdAt": "2020-11-11T09:17:00.604Z",
"updatedAt": "2022-07-12T10:12:34.778Z",
"path": "server",
"sort": 1
}
}
# 编辑
接口说明
修改路由
接口版本
v1接口地址
/api-v1/general-routers/: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": {
"children": [],
"roles": [
{
"_id": "5d9feb2f377ce1001b905b3d",
"name": "普通用户",
"sort": 3,
"desc": "注册普通用户",
"createdAt": "2019-10-11T02:38:39.672Z",
"updatedAt": "2019-10-11T06:15:37.785Z",
"__v": 0
}
],
"_id": "5fabac0ca4475c001bd34670",
"name": "测试路由",
"keepAlive":true,
"showLink":true,
"redirect": "",
"icon":"el-icon",
"createdAt": "2020-11-11T09:17:00.604Z",
"updatedAt": "2022-07-12T10:12:34.778Z",
"path": "server",
"sort": 1
}
}
# 修改路由中的权限
接口说明
修改路由中的权限
接口版本
v1接口地址
/api-v1/general-routers/roles-auth
请求方法
PUT
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
roleId | - | ObjectId | True | 权限id |
_ids | - | ObjectId[] | True | 路由id数组 |
请求参数举例
{
"roleId": "642506bcc5e22c30d8b4fdeb",
"_ids":["5fababdda4475c001bd3426d", "5fabac0ca4475c001bd34670", "5fabac43a4475c001bd34b6e"]
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回创建的对象 |
返回参数举例
{
code: 0,
message: "OK"
}
上次更新: 2023/03/30, 17:07:08