211 lines
5.0 KiB
JSON
211 lines
5.0 KiB
JSON
{
|
||
"generatedAt": "2026-04-18 19:40:53",
|
||
"generatedAtLocal": "2026-04-18 19:40:53",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "角色管理模块",
|
||
"key": "setting.role",
|
||
"folder": "setting.role",
|
||
"interfaceCount": 5
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "setting.role.list",
|
||
"title": "获取当前主体可管理的角色树",
|
||
"description": "获取当前主体可管理的角色树",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "includeDisabled",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否包含已停用角色"
|
||
},
|
||
{
|
||
"name": "includeSystem",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否包含系统角色域"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "setting.role.permission",
|
||
"title": "获取角色权限树(兼容旧入口,等同于 setting.permission.list)",
|
||
"description": "获取角色权限树(兼容旧入口,等同于 setting.permission.list)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "role_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "角色ID"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "setting.role.add",
|
||
"title": "新增角色并绑定权限集合",
|
||
"description": "新增角色并绑定权限集合",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "role_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "角色编码"
|
||
},
|
||
{
|
||
"name": "role_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "角色名称"
|
||
},
|
||
{
|
||
"name": "permission_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "权限ID数组,支持 [\"*\"]"
|
||
},
|
||
{
|
||
"name": "pid",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "父角色ID"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "setting.role.update",
|
||
"title": "更新角色信息并重设权限集合",
|
||
"description": "更新角色信息并重设权限集合",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "role_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "角色ID"
|
||
},
|
||
{
|
||
"name": "permission_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "权限ID数组,角色权限需一次性提交"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "setting.role.delete",
|
||
"title": "批量停用角色",
|
||
"description": "批量停用角色",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "待停用的角色ID数组"
|
||
}
|
||
],
|
||
"response": []
|
||
}
|
||
]
|
||
}
|