API管理
API管理功能 用于管理所有的API,在API管理将API分配给租户,租户在可以客户化菜单下的权限集维护权限(API),租户查看被分配的API可以在同功能下的租户API管理页下搜索被分配的API,API管理只有平台层功能。
API管理功能主要分为分配
API给租户,回收
被分配的API 。
-
菜单路径:系统管理 > 菜单管理 > API管理
-
菜单层次:平台级
API管理
API管理页可查询所有的API。
列表字段:
-
描述:API描述字段,简单介绍该API的功能,多语言维护。
-
权限编码:API编码。
-
路径 :API路径。
-
请求方式:HTTP请求的方式。
-
权限层级:API对应的层级,目前的类型为平台级、租户级、和项目三种。
-
服务名称:API对应的服务名。
-
标签 : API标签,后端标签显示为红色,页面标签显示为绿色。
-
是否公开接口:是否公开的API。
-
是否登录可访问:是否需要登录才能访问的API。
-
是否内部接口:是否为内部接口。
-
操作: 可编辑和删除API。
查询字段
-
权限编码: API编码,支持模糊查询。
-
路径:API路径,支持模糊查询。
-
服务名称:服务名称,通过lov选择服务名称
-
权限层级:API对应的层级,目前的类型为平台级、租户级、和项目三种。下拉框选择对应的权限层级
-
请求方式 :http请求方式
-
标签:api标签,下拉框选择标签
编辑
点击编辑按钮进入编辑页面,在该页面可编辑API的信息。
可编辑字段:
-
描述:API描述字段,简单介绍该API的功能。
-
页面标签:API标签内容,此处可维护在标签管理功能下维护的页面标签内容。
参数修改完成后点击 确定
按钮完成修改。
分配API
- 注:此功能只在平台层下能使用
租户客户化菜单下可维护权限集,权限集下维护的权限,需要在此API管理功能分配API权限给租户。
勾选需要分配的API,点击分配按钮,会弹出租户的选择页,可以多选租户,勾选需要分配API的租户,点击确定按钮,批量分配给多个租户。
查看和管理租户的API,可以在该页面上租户API管理页面管理
刷新权限
需通过【刷新
】按钮手动刷新表IAM权限。
- 服务名:要刷新的服务名称
- 服务标记版本:标记版本取自服务配置中的
eureka.instance.metadata-map.VERSION
- 是否清除过期权限:是否清理过期权限
删除API
- 批量删除
勾选需要删除的API,点击删除按钮删除API,批量删除API。
- 删除
点击行上的删除按钮,删除当前行的API。
删除API也会回收所有分配给租户的API。
点击删除按钮会弹出确认删除提示框,点击确定后删除,点击取消取消删除(避免误操作)。
租户API管理
- 注:此功能只在平台层下能使用
租户API管理可查看所有分配给租户的API,也可根据条件租户
查询某个租户下的API。
列表字段:
-
租户:租户名称
-
描述:API描述字段,简单介绍该API的功能。
-
权限编码:API编码。
-
路径 :API路径。
-
请求方式:HTTP请求的方式。
-
权限层级:API对应的层级,目前的类型为租户级。
-
服务名称:API对应的服务名。
-
是否公开接口:是否公开的API。
-
是否登录可访问:是否需要登录才能访问的API。
-
是否内部接口:是否为内部接口。
-
操作: 删除租户API。
查询字段
-
租户:租户,LOV选择,查询租户的API权限
-
权限编码: API编码,支持模糊查询。
-
路径:API路径,支持模糊查询。
-
服务名称:服务名称,通过lov选择服务名称
-
请求方式 :http请求方式
回收租户API
- 批量删除
勾选需要回收的API,点击删除按钮回收分配给对应租户的API。
- 删除
点击行上的删除按钮,回收当前行对应租户的API。
点击删除按钮会弹出确认删除提示框,点击确定后回收,点击取消取消回收API(避免误操作)。