获取角色列表
查看文档来源信息
- 来源目录:
addons/sys_base/docs - 来源文件:
接口文档/09-获取角色列表.md
详细说明
用于分页或按条件查询角色列表。
接口信息
| 项目 | 内容 |
|---|---|
| 请求方式 | POST |
| 请求路径 | /sys_base/platform/authority/getAuthorityList |
| 来源文件 | 接口文档/09-获取角色列表.md |
请求头
| 请求头 | 示例值 | 说明 |
|---|---|---|
Content-Type | application/json | 请求体格式。 |
x-token | <登录令牌> | 登录令牌。 |
app-id | mid-admin | 当前应用 ID。 |
addons-type | sys_base | 当前模块标识。 |
入参
| 参数名 | 类型 | 是否必填 | 示例值 | 参数说明 |
|---|---|---|---|---|
page | number | 否 | 1 | 页码 |
pageSize | number | 否 | 20 | 每页条数 |
keyword | string | 否 | 管理员 | 关键字 |
addonsType | string | 否 | sys_base | 模块标识 |
参数说明
page:页码。pageSize:每页条数。keyword:关键字。addonsType:模块标识。
请求示例
json
{
"page": 1,
"pageSize": 20,
"keyword": "管理员",
"addonsType": "sys_base"
}响应输出
json
{
"code": 1000,
"msg": "操作成功",
"data": {
"list": [
{
"id": 1,
"name": "示例记录"
}
],
"total": 1,
"page": 1,
"pageSize": 20
}
}字段说明
| 字段名 | 类型 | 示例值 | 字段说明 |
|---|---|---|---|
code | number | 1000 | 业务状态码 |
msg | string | 操作成功 | 返回消息 |
data.list | array | [...] | 列表数据 |
data.total | number | 1 | 总条数 |
data.page | number | 1 | 当前页码 |
data.pageSize | number | 20 | 每页条数 |
curl 示例
bash
curl --location --request POST 'http://127.0.0.1:8100/sys_base/platform/authority/getAuthorityList' \
--header 'Content-Type: application/json' \
--header 'x-token: <登录令牌>' \
--header 'app-id: mid-admin' \
--header 'addons-type: sys_base' \
--data-raw '{
"page": 1,
"pageSize": 20,
"keyword": "管理员",
"addonsType": "sys_base"
}'