WormHole网关平台API管理台操作说明

作者: admin 分类: WormHole 发布时间: 2019-03-13 00:11  阅读: 595 views

 

WormHole 管理台操作说明
 

1、服务启动好之后浏览器访问项目地址: localhost:8141/

wormhole网关服务平台

2、输入默认账号密码 root/ 123456 打开以下页面

wormhole网关服务平台

看到左侧有多个菜单,右边为操作主界面。功能如下:

WormHole平台操作说明
系统 用户管理 管理台的用户,可以赋予角色进行功能操作。
如:
接口的接入方可以用账号查看接口的调用方式;
接口的生产方可以用账号进行数据录入及测试;
测试方可以查看相关信息等。
角色管理 管理台的角色,可以根据操作权限进行划分。
如:
系统管理员可以操作所有功能;
接口的接入方只能查看接口相关数据;
接口的生产方可以维护接口数据;
测试方可以切换环境进行测试。
资源管理 管理台的所有操作权限管理,精确到功能点。一个url请求地址算一个功能。
网关 用户管理 使用网关功能,需要先创建用户。可以针对不同终端设定多个用户。
应用管理 从属于用户下的应用,可以给应用授权能使用那些API接口或API接口分组。一个用户可以创建多个应用。
分组管理 针对于API接口的分类管理。方便权限的分配、或者接口的查询。
接口管理 对于接口的增、删、改、查、复制、测试、同步等功能的处理。主要是API接口的开发人员使用。
标签管理 给API接口贴标签,方便接口的查询与管理

****

 

3、网关数据的一般操作流程如下

a) 【管理员】增加网关用户

b) 【管理员】增加用户应用

c) 【后端】增加API接口分组数据

d) 【管理员】应用授权可用接口/接口组

e) 【后端】新建API接口信息

包括基本信息、dubbo信息、响应信息、参数信息等

f) 【后端】测试API接口数据的正确性

g) 【后端】给API接口贴标签

h) 【前端】查看API接口信息进行联调

i) 【管理员/后端】同步数据到线上

注: 同步到线上的功能,需要两套库环境,并配置正确的同步地址。

 

4、接口管理模块
(其他功能的操作比较简单,不多做介绍)

(a)打开网关接口 –> 接口管理 –> 新增API接口 界面如下

wormhole网关服务平台

普通接口

wormhole网关服务平台

回调接口
表单项说明:
* 分组信息:创建API之前,先在分组管理中建立好
* API名称:这里验证了名称的格式,必须如user.login。用于区分不同业务的名称。不能和已有上线状态的接口重名,删除状态的可以。
* API描述:指对API接口的描述,说明接口作用等
* API状态:默认上线状态,在dev\test\online环境皆可使用。这里的删除只是逻辑删除,防止物理删除后数据关系丢失。
* 接口类型:主要包括普通接口和回调接口
* 普通接口可以设置http请求方式、是否鉴权、是否登录的属性
* 回调接口可以设置http请求方式、回调响应头属性
* 两种接口的请求方式和执行过程不一样
* 请求类型:只设置了 get 、post两种类型
* 是否鉴权:确定接口是否参与签名验证、和权限验证。回调接口不参与。
* 是否登录:确定接口是否需要登录才能访问。回调接口不参与。
* 鉴权协议版本:本系统只有一套协议。可以制订多套协议,区别处理。这里输入任何值都可以
* 回调响应头:某些三方平台回调之后需要返回数据,且设置响应头信息。如果不需要则,无需设置。格式如下:
{‘character-encoding’:’utf-8′,’content-type’:’text/xml;charset=UTF-8′,’cache-control’:’no-cache’}
* 接口全路径:包名+类名,要填写正确
* 方法名称:接口调用的具体方法名称,区分大小写
* 服务版本号:环境区分为local、dev、test、online四种。根据需求设置
* 超时时间:设定接口的超时时间,根据需求设定,默认3000毫秒
* 创建者:可以选择接口的开发者进行绑定,从而一旦出现问题可以快速定位问题,找到相关负责人。具体名单可以在com.kaistart.gateway.config.RunConfig.auths中设置。
当全部设置好后,这里只是保存了基本信息。

(b) 打开网关接口 –> 接口管理 -> 找到刚才新增的接口记录 –> 编辑

看到以下页面、内容较多,截三屏

wormhole网关服务平台
wormhole网关服务平台
wormhole网关服务平台

除了刚才新增API接口是的基本信息外,多了关联标签设置、API请求示例、API参数信息。
* 基本信息可以按需进行调整
* 关联标签信息,可以对接口进行标记。请先设置好标签后,进行绑定
* API请求示例,是设置该接口的响应示例结果,示例解释以及响应码结果。
这里分为三个字段展示,方便后期的扩展。针对json格式的友好展示和支持可按需调整。
* API参数信息,设定接口的参数信息。由于dubbo泛化调用对参数的格式有要求、所以这里要正确设置顺序及类型。系统中严格定义dubbo服务方法的参数如果是自定义类型的,接口需要定义为post请求类型。如果方法的参数非敏感、少于3个,可以定位为get请求。如下:
* public String methodA(com.test.DubboService d) 参数为自定类型
接口需要定义为POST请求,
参数类型选择自定义类型, 类型名称为com.test.DubboService
* public String methodB(String uName,String uPass) 为基本/封装类型
接口需要定义为GET请求
参数类型选择java.lang.String,类型名称为java.lang.String
* 回调接口的参数定义请查看xxx

 

5、查看接口列表及功能列表如下

wormhole网关服务平台

* 接口可按照条件进行查询
* 删除:当前接口被逻辑删除
* 详情:C端查看接口详情,可以调试
* 复制:制作当前接口的副本,方便不同环境的切换及快速编辑
* 测试:开发可以进行接口的自测及权限的验证
* 编辑:对接口进行维护
* 同步:当线上环境无法直接编辑接口时,可以使用同步功能。

 

6、接口测试功能

点击接口管理 –> 测试 出现以下界面

wormhole网关服务平台
wormhole网关服务平台

基本参数
* 请求类型会自动匹配
* 请求环境根据配置文件中的配置,进行环境判断。可以按需选择或自定义
* 请求地址需要注意项目名称,根据实际配置,进行增减
* Mock功能默认选中状态,表示接口会正常执行组件的调用链,但最后不会真正去调用dubbo服务,但是会返回定义接口时保存的结果示例信息。方便接口的调试等。

请求参数(分为header参数和body参数)
* content-type 请求体类型,可扩展
* appKey 设定网关应用的key信息,默认选中第一个。
* sign 签名串验证参数,点击发送时自动填充
* auth是MD5(sign+token)计算来验证用户登录的信息,发送时自动填充
* userId是当接口需要登录访问时输入。测试时请确保相关redis中有值
* t 时间戳,加强安全性
* deviceId 终端信息编号,按需使用
* body参数只有接口为post请求时才显示。需要json格式

响应结果
* 点击发送后,这里会显示当前请求的结果。根据错误码做对应处理。

 

7、查看接口详情功能,用于C端调试,如下

wormhole网关服务平台


   原创文章,转载请标明本文链接: WormHole网关平台API管理台操作说明

如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!

发表评论

电子邮件地址不会被公开。 必填项已用*标注

更多阅读