组件介绍
菜单服务提供菜单维护及权限管理的功能,实现了统一前端菜单信息维护及细粒度权限的用户菜单控制。
API 参考
API 列表(共10个)
序号 | 接口 | 接口描述 | 版本 |
1 | 获取用户可见菜单【登录时使用】 | GET: /menu2/menus | V1.00 |
2 | 删除菜单 | POST: /menu2/deleteMenu | V1.00 |
3 | 获取应用菜单树 | GET: /menu2/listMenus | V1.00 |
4 | 根据菜单ID获取菜单 | GET: /menu2/menu | V1.00 |
5 | 新增菜单 | POST: /menu2/menu | V1.00 |
6 | 菜单绑定 功能 | POST: /menu2/menuBindAuth | V1.00 |
7 | 菜单绑定 角色 | POST: /menu2/menuBindAuthGroup | V1.00 |
8 | 菜单解绑 功能 | POST: /menu2/menuUnBindAuth | V1.00 |
9 | 菜单解绑 角色 | POST: /menu2/menuUnBindAuthGroup | |
10 | 修改菜单信息 | POST: /menu2/updateMenu |
获取用户可见菜单【登录时使用】
基本信息
Path: /menu2/menus
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
appKey | 是 | 应用Key |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
object [] | 非必须 | item 类型: object | |||
├─ appKey | string | 必须 | 所属应用 | ||
├─ authGroupNames | string | 必须 | 逗号风格的角色组名,如果为空,或者空字符串,则表示所有用户都拥有 | ||
├─ children | string[] | 非必须 | item 类型: string | ||
├─ | 非必须 | ||||
├─ id | integer | 必须 | 菜单id | format: int64 | |
├─ menuLogo | string | 必须 | 菜单logo | ||
├─ menuName | string | 必须 | 菜单名称 | ||
├─ menuOrder | number | 必须 | 菜单序号 | format: double | |
├─ menuType | integer | 必须 | 菜单类型 0:页面菜单,1:功能菜单 | format: int32 | |
├─ menuUrl | string | 必须 | 菜单url | ||
├─ parentId | integer | 必须 | 父菜单Id | format: int64 | |
├─ roleNames | string | 必须 | 逗号风格的角色名,如果为空,或者空字符串,则表示所有用户都拥有 |
删除菜单
基本信息
Path:/menu2/deleteMenu
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
menuId | integer | 必须 | Long类型,菜单Id | ||
appKey | string | 必须 | 应用Key |
获取应用菜单树
基本信息
Path: /menu2/listMenus
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
appKey | 是 | 应用Key |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
object [] | 非必须 | item 类型: object | |||
├─ appKey | string | 必须 | 所属应用 | ||
├─ authGroupNames | string | 必须 | 逗号风格的角色组名,如果为空,或者空字符串,则表示所有用户都拥有 | ||
├─ children | string[] | 非必须 | item 类型: string | ||
├─ | 非必须 | ||||
├─ id | integer | 必须 | 菜单id | format: int64 | |
├─ menuLogo | string | 必须 | 菜单logo | ||
├─ menuName | string | 必须 | 菜单名称 | ||
├─ menuOrder | number | 必须 | 菜单序号 | format: double | |
├─ menuType | integer | 必须 | 菜单类型 0:页面菜单,1:功能菜单 | format: int32 | |
├─ menuUrl | string | 必须 | 菜单url | ||
├─ parentId | integer | 必须 | 父菜单Id | format: int64 | |
├─ roleNames | string | 必须 | 逗号风格的角色名,如果为空,或者空字符串,则表示所有用户都拥有 |
根据菜单ID获取菜单
基本信息
Path: /menu2/menu
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
menuId | 是 | 菜单ID | |
appKey | 是 | 应用Key |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
object [] | 非必须 | item 类型: object | |||
├─ appKey | string | 必须 | 所属应用 | ||
├─ authGroupNames | string | 必须 | 逗号风格的角色组名,如果为空,或者空字符串,则表示所有用户都拥有 | ||
├─ children | string[] | 非必须 | item 类型: string | ||
├─ | 非必须 | ||||
├─ id | integer | 必须 | 菜单id | format: int64 | |
├─ menuLogo | string | 必须 | 菜单logo | ||
├─ menuName | string | 必须 | 菜单名称 | ||
├─ menuOrder | number | 必须 | 菜单序号 | format: double | |
├─ menuType | integer | 必须 | 菜单类型 0:页面菜单,1:功能菜单 | format: int32 | |
├─ menuUrl | string | 必须 | 菜单url | ||
├─ parentId | integer | 必须 | 父菜单Id | format: int64 | |
├─ roleNames | string | 必须 | 逗号风格的角色名,如果为空,或者空字符串,则表示所有用户都拥有 |
新增菜单
基本信息
Path: /menu2/menu
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
appKey | string | 必须 | 所属应用 | ||
authGroupNames | string | 必须 | 逗号风格的角色组名,如果为空,或者空字符串,则表示所有用户都拥有 | ||
children | string[] | 非必须 | item 类型: string | ||
├─ | 非必须 | ||||
id | integer | 必须 | 菜单id | format: int64 | |
menuLogo | string | 必须 | 菜单logo | ||
menuName | string | 必须 | 菜单名称 | ||
menuOrder | number | 必须 | 菜单序号 | format: double | |
menuType | integer | 必须 | 菜单类型 0:页面菜单,1:功能菜单 | format: int32 | |
menuUrl | string | 必须 | 菜单url | ||
parentId | integer | 必须 | 父菜单Id | format: int64 | |
roleNames | string | 必须 | 逗号风格的角色名,如果为空,或者空字符串,则表示所有用户都拥有 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
appKey | string | 必须 | 所属应用 | ||
authGroupNames | string | 必须 | 逗号风格的角色组名,如果为空,或者空字符串,则表示所有用户都拥有 | ||
children | string[] | 非必须 | item 类型: string | ||
├─ | 非必须 | ||||
id | integer | 必须 | 菜单id | format: int64 | |
menuLogo | string | 必须 | 菜单logo | ||
menuName | string | 必须 | 菜单名称 | ||
menuOrder | number | 必须 | 菜单序号 | format: double | |
menuType | integer | 必须 | 菜单类型 0:页面菜单,1:功能菜单 | format: int32 | |
menuUrl | string | 必须 | 菜单url | ||
parentId | integer | 必须 | 父菜单Id | format: int64 | |
roleNames | string | 必须 | 逗号风格的角色名,如果为空,或者空字符串,则表示所有用户都拥有 |
菜单绑定 功能
基本信息
Path: /menu2/menuBindAuth
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
authorityKeys | string [] | 必须 | item 类型: string | ||
├─ | 非必须 | ||||
menuId | integer | 必须 | 菜单Id | format: int64 |
菜单绑定 角色
基本信息
Path: /menu2/menuBindAuthGroup
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
authorityGroupKeys | string [] | 必须 | item 类型: string | ||
├─ | 非必须 | ||||
menuId | integer | 必须 | 菜单Id | format: int64 |
菜单解绑 功能
基本信息
Path: /menu2/menuUnBindAuth
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
authorityKeys | string [] | 必须 | item 类型: string | ||
├─ | 非必须 | ||||
menuId | integer | 必须 | 菜单Id | format: int64 |
菜单解绑 角色
基本信息
Path: /menu2/menuUnBindAuthGroup
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
authorityVGroupKeys | string [] | 必须 | item 类型: string | ||
├─ | 非必须 | ||||
menuId | integer | 必须 | 菜单Id | format: int64 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
修改菜单信息
基本信息
Path: /menu2/updateMenu
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
appKey | string | 必须 | 所属应用 | ||
authGroupNames | string | 必须 | 逗号风格的角色组名,如果为空,或者空字符串,则表示所有用户都拥有 | ||
children | string[] | 非必须 | item 类型: string | ||
├─ | 非必须 | ||||
id | integer | 必须 | 菜单id | format: int64 | |
menuLogo | string | 必须 | 菜单logo | ||
menuName | string | 必须 | 菜单名称 | ||
menuOrder | number | 必须 | 菜单序号 | format: double | |
menuType | integer | 必须 | 菜单类型 0:页面菜单,1:功能菜单 | format: int32 | |
menuUrl | string | 必须 | 菜单url | ||
parentId | integer | 必须 | 父菜单Id | format: int64 | |
roleNames | string | 必须 | 逗号风格的角色名,如果为空,或者空字符串,则表示所有用户都拥有 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
产品版本
日期 | 修改描述 |
2019-6-21 | 初版发布 |
2020-4-18 | 优化:修改获取菜单接口,对于在应用下没有权限的用户,菜单返回空 |
2020-4-26 | 新特性:技术部要求统一异常规范, 更新logback,简化客户端的异常处理方式 |
2020-5-20 | 新特性:提升swagger的版本,补充swagger模型的注释,清晰明确接口的调用 |
更新日志
日期 | 修改描述 |
2019-6-21 | 发布菜单服务,创建菜单服务的用户使用手册 |