获取已发布菜单角色授权状态
查看文档来源信息
- 来源目录:
addons/sys_base/docs - 来源文件:
接口文档/获取已发布菜单角色授权状态.md
详细说明
读取当前模块已发布 system_menu 清单,并返回指定角色在该清单下的页面、动作、默认页和运行承载状态。该接口是下游业务菜单授权页的正式读取入口,不读取代码动作清单,不展示共享治理兜底菜单。
接口信息
| 项目 | 内容 |
|---|---|
| 请求方式 | GET |
| 请求路径 | /sys_base/platform/manifest/getPublishedMenuAuthorityStatus |
| 来源文件 | 接口文档/获取已发布菜单角色授权状态.md |
请求头
| 请求头 | 示例值 | 说明 |
|---|---|---|
x-token | <token> | 登录令牌。 |
app-id | <app-id> | 当前应用 ID。 |
addons-type | settlement_center | 当前模块标识。 |
入参
查询参数示例:
text
addonsType=settlement_center&accessMode=role&authorityId=20参数说明
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
addonsType | string | 是 | 当前模块标识 |
accessMode | string | 否 | 读取视角,取值为 role 或 super_admin;为空时按当前 token 上下文解析 |
authorityId | number | role 模式必填 | 目标角色 ID;super_admin 模式固定为 0 |
请求示例
当前文档未提供独立请求示例,请参考下方 curl 示例。
响应输出
json
{
"code": 0,
"data": {
"summary": {
"published": true,
"addonsType": "settlement_center",
"authorityId": 20,
"isSuperAdminRole": false,
"pageCount": 3,
"grantedPageCount": 1,
"actionCount": 5,
"grantedActionCount": 2,
"partialActionCount": 0,
"missingActionCount": 3,
"compareScope": "published_system_menu",
"compareNote": "当前授权来源为已发布 system_menu 清单。"
},
"publishSummary": {
"supported": true,
"addonsType": "settlement_center",
"codePageCount": 3,
"codeActionCount": 5,
"publishedCount": 3,
"missingCount": 0,
"actionPublishedCount": 5,
"actionMissingCount": 0,
"compareScope": "published_system_menu",
"compareNote": "按当前模块已发布 system_menu 清单检查运行承载。"
},
"list": [
{
"pageCode": "settlement_center.workbench",
"pageTitle": "工作台",
"menuFlag": "settlement_center.workbench",
"routeName": "settlementCenterWorkbench",
"routePath": "settlement_center/workbench",
"componentPath": "view/workbench/index.vue",
"pageGranted": true,
"hidden": false,
"actions": [
{
"actionCode": "settlement_center.workbench.view",
"actionTitle": "查看工作台",
"menuFlags": ["settlement_center.workbench.view"],
"grantStatus": "granted",
"grantedKeys": ["settlement_center.workbench.view"],
"missingKeys": []
}
]
}
],
"tree": [],
"defaultPage": {
"pageCode": "settlement_center.workbench",
"resolved": true,
"source": "published_menu"
}
},
"msg": "success"
}字段说明
| 字段 | 说明 |
|---|---|
data.summary.published | 当前模块是否已有正式发布的 system_menu |
data.summary.pageCount | 已发布菜单中的可见页面数量 |
data.summary.grantedPageCount | 目标角色已授权页面数量 |
data.summary.actionCount | 已发布菜单中的动作数量 |
data.summary.grantedActionCount | 目标角色已完整授权动作数量 |
data.publishSummary.missingCount | 已发布页面缺少运行承载记录的数量 |
data.publishSummary.actionMissingCount | 已发布动作缺少运行承载记录的数量 |
data.list | 授权页使用的页面与动作状态列表 |
data.list[].componentPath | 发布对照字段,仅用于检查菜单清单与 PCWEB 本地注册表是否一致,不是前端运行时组件加载契约 |
data.tree | 当前已发布菜单运行树,供需要展示完整菜单结构的调用方使用 |
data.defaultPage | 当前视角解析后的默认页 |
curl 示例
bash
curl --location --request GET 'http://127.0.0.1:8100/sys_base/platform/manifest/getPublishedMenuAuthorityStatus?addonsType=settlement_center&accessMode=role&authorityId=20' \
--header 'x-token: <token>' \
--header 'app-id: <app-id>' \
--header 'addons-type: settlement_center'