OpenAPI接口测试工具（海康威视Infovision IoT）.pdf

OpenAPI 接口测试工具（海康威视 Infovision IoT） 本文档主要描述了 OpenAPI 接口测试工具的使用说明，该工具用于测试 OpenAPI 接口是否正常。该工具支持现已发布且具备 API 网关的 ISC、IOT 平台基线的 OpenAPI 接口的调用，支持 http/https 协议的接口调用，依赖 .net 4.5 环境，并支持图片相关接口的调用。 一、初衷 随着 API 网关的广泛使用，项目上也会有越来越多的第三方平台对接 OpenAPI，为了方便验证 OpenAPI 接口是否正常，开发了这个接口测试工具。 二、软件说明 该工具支持现已发布且具备 API 网关的 ISC、IOT 平台基线的 OpenAPI 接口的调用，支持 http/https 协议的接口调用，依赖 .net 4.5 环境，并支持图片相关接口的调用。 三、使用方法 使用该工具时，需要按照以下步骤操作： 1. 打开可执行程序 iSC_Http_Openapi.exe； 2. 输入 Appkey/Secret，从运管中心-状态监控-API 网关-API 管理-合作方管理中获取； 3. 选择协议，http 或 https，确保所选选择的协议可以登录门户； 4. 选择方法，POST 或 GET，目前大部分的接口都是 POST 方法，单点登录定制成果物中的获取凭证的接口是 GET 方法； 5. 输入平台地址，门户登录地址，注意端口要和所选的协议匹配（http 默认端口 80，https 默认端口 443，如有修改，以实际端口为准）； 6. 输入请求 URL，具体接口说明中的请求地址； 7. 输入请求参数，具体接口说明中的请求 Body； 8. 选择图片接口是否自动下载，调用获取图片相关接口是否自动下载图片到本地； 9. 选择时间转 ISO8061 格式，是否把入参中的时间参数转换为 ISO8061 格式（2017-06-15T00:00:00.000+08:00），绝大部分的带时间的接口均使用的这种格式，部分接口时间入参不是这种格式的时候不勾选。 四、配置文件 为了方便大家使用，不需要每次打开工具都要手动输入 Appkey、Secret、协议、平台地址，增加了配置文件，可以通过修改配置文件，工具每次打开时从配置文件中自动加载相关信息。 五、特别说明 5.1 GET 方法接口使用说明 目前用到 GET 方法的接口只遇到过一个用来获取单点登录跳转 iSC 平台首页的登录凭证的接口（/api/cas/v1/tgt/login），GET 方法的 url 可以通过以下两种方式请求： 方式一：请求的 URL 只传接口地址：/api/cas/v1/tgt/login；请求入参以 json 格式放到请求参数中，工具的代码中会把入参的 json 格式转成 Map，在发送 http 请求的时候会把参数拼接到请求地址后（GET 方法的传参方式）。 方式二：把请求参数在拼接到请求 URL 后边传入，请求参数中不需要再传入参数，按照这种方式调用的时候，请求 URL 后边的入参顺序一定要按照参数名的首字母顺序排序传入。 该 OpenAPI 接口测试工具可以方便地测试 OpenAPI 接口是否正常，支持多种协议和图片相关接口的调用，并提供了配置文件方便使用。