接口透传导图
外部系统通过接口平台的服务注册功能模块将接口注入到接口平台。接口平台生成发布地址供其他系统调用。接口平台有自己相对独立的鉴权系统。
快速开始
step1: 准备外部系统接口
准备一个外部系统的接口,注入到接口平台。这里的外部系统以HIAM为例。
step2: 新建服务
新建一个Code为QUICK_START的服务,服务地址为http://hzeronb.saas.hand-china.com/iam
step3: 给服务配置认证信息
1,配置访问HIAM服务需要的认证信息(HZERO服务认证采用的OAUTH2的方式,我们只需要配置一下客户端就好)。登录HZERO,切换到租户管理员,搜索菜单’客户端',配置客户端。
2, 将认证信息配置到QUICK_START服务中。
step4: 新建接口
创建一个CODE为QUICK_START_ITF的接口,接口地址为/hzero/v1/roles/admin-role/{roleId}
step5: 将接口授权给角色
用超级管理员登录,切换到 接口平台
>接口授权
>角色授权
菜单,将刚刚QUICK_START_ITF接口授权给当前用户租户管理员。
(若自己就是超级管理员,接口权限默认都会挂到超级角色下面)
step6: 测试接口是否正常
1, 进入页面接口平台
>服务注册
>编辑接口文档
>测试用例
2,点击新建,生成一个测试用例。
3,点击编辑配置路径参数
4,点击执行
5,点击查看测试历史,看是否执行成功
通过测试用例测试接口是否正常
step7: 通过SDK调用(内部调用)
这里的内部调用指Hzero体系内的微服务调用。内部调用推荐SDK调用。
1,首先在调用方的POM文件,依赖SDK客户端。
<!-- SDK 依赖 -->
<dependency>
<groupId>org.hzero.boot</groupId>
<artifactId>hzero-boot-interface</artifactId>
<version>${hzero.boot.version}</version>
</dependency>
2, 点击测试用例
>代码预览
>‘JAVA’复制粘贴即可,具体有关SDK介绍请查询相关文档
step8: 外部系统通过发布地址调用
这里以postman 作为演示例子
1,登录HZERO。
因为接口平台发布地址是登录即可访问,所以需要登录HZERO。Hzero对外提供客户端登录方式。
- 在Hzero平台新建一个客户端。
因为我们仅仅需要登录就行,所以我们甚至都不需要为其分配角色。功能入口: 切换到租户管理员
> 菜单搜索客户端
- 将接口授权给客户端。
我们知道整个HZERO体系,权限都是直接关联到角色上面的。用于是否拥有该权限完全取决于其角色是否拥有该权限。接口平台鉴权也保证了一样的逻辑关系。所以我们需要先将我们注册的接口授权给角色,参考Step4和step5。接下来我们将该角色授权给客户端,点开接口平台的客户端授权,然后将step5的角色授权给客户端。
2,用客户端生成一个token,通过发布地址访问接口。
- 获取token
- 调用发布地址