OpenAPI接口测试工具
一、初衷
随着API网关的广泛使用,项目上也会有越来越多的第三方平台对接OpenAPI,为了方便验证OpenAPI接口是否正常,开发了这个接口测试工具。
二、软件说明
支持现已发布且具备API网关的ISC、IOT平台基线的OpenAPI接口的调用;
支持http/https协议的接口调用;
依赖 4.5环境;
支持图片相关接口的调用;
三、使用方法
1、打开可执行程序iSC_;
2、Appkey/Secret:合作方Key和Secret(从运管中心-状态监控-API网关-API管理-合作方
管理,点开具体合作方获得);
app接口测试工具3、协议:Http/Https,调用OpenAPI网关接口的协议,确保所选选择的协议可以登录门户;
4、Method:调用接口的方法POST/GET,目前大部分的接口都是POST方法,单点登录定
制成果物中的获取凭证的接口是GET方法(使用方法参考5.1 GET方法接口使用说明);
5、平台地址:门户登录地址,注意端口要和所选的协议匹配(http默认端口80,https默认
端口443,如有修改,以实际端口为准);
6、请求URL:具体接口说明中的请求地址。
7、请求参数:具体接口说明中的请求Body。
8、图片接口是否自动下载:调用获取图片相关接口是否自动下载图片到本地(获取门禁事件
的图片、查询车辆抓拍图片、人脸应用-图片下载、提取人员图片等接口),开启自动下载后,会把对应的图片下载到工具根目录的downloadpics文件夹下。
9、时间转ISO8061格式:是否把入参中的时间参数转换为ISO8061格式(2017-06-
15T00:00:00.000+08:00),绝大部分的带时间的接口均使用的这种格式,部分接口时间入参不是这种格式的时候不勾选(例如:查询来访记录接口)
10、返回结果:http接口调用返回结果。
四、配置文件
为了方便大家使用,不需要每次打开工具都要手动输入Appkey、Secret、协议、平台地址,增加了配置文件,可以通过修改配置文件,工具每次打开时从配置文件中自动加载相关信息,配置文件相关说明如下:
五、特别说明
5.1GET方法接口使用说明
目前用到GET方法的接口只遇到过一个用来获取单点登录跳转iSC平台首页的登录凭证的接口(/api/cas/v1/tgt/login),GET方法的url可以通过以下两种方式请求:
方式一:
请求的URL只传接口地址:/api/cas/v1/tgt/login;
请求入参以json格式放到请求参数中,如图所示;
按这种方式请求的时候,工具的代码中会把入参的json格式转成Map,在发送http请求的时候会把参数拼接到请求地址后(GET方法的传参方式)
IP:Port/artemis/api/cas/v1/tgt/login?language=zh_CN&service=10.2.148.81/&userCode= admin
方式二:
把请求参数在拼接到请求URL后边传入,请求参数中不需要再传入参数,如图所示:
注意:按照这种方式调用的时候,请求URL后边的入参顺序一定要按照参数名的首字母顺序排序传入,l(language)->s(service)->u(userCode),所以,请求URL中应该传入的是/api/cas/v1/tgt/login?language=zh_CN&service=10.2.148.81/&userCode=admin
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论