全部产品
云市场

API测试

更新时间:2019-12-11 23:41:04

确保API发布成功以后,就可以到测试页面中测试调用该API了。测试时,控制台页面会根据所填参数,模拟发起真实的HTTP请求。

测试前,确保配置的业务后端应用正常,且对应接口可用。若该业务应用配置的机器组包含多台机器,要确保每台机器状态都正常。

发起测试请求

  • API测试设置

    • 请求方式:指定模拟请求的HttpMethod
    • APPKey:指定模拟请求使用的APP身份,测试中,任意APPKey都可使用;
    • 请求body:若请求方式为POST,则可以选择请求body类型,包括:JSON透传、FORM表单;
    • 透传JSON:若选择body类型为JSON透传,则可以输入一段json,作为请求的body内容;
  • 请求业务参数

    • 无论是GET或者POST,是JSON透传还是FORM表单,都可以添加自定义的业务参数。这些参数的键值对会根据具体请求模式,携带在请求的QueryString或者Body Parameters中。携带位置对于业务来说是等价的,都是HTTP请求的请求参数,可以忽略这些区别;
  • 请求协议参数

    • ttid:渠道id,保持默认即可,目前该参数没有使用;
    • utdid:保持默认即可;该参数真实场景中用于在日志中标记请求的设备;
    • location:保持默认即可;该参数真实场景中需要业务自行设置;
  • 请求header设置

    • 指定模拟请求发起时,添加额外的Http Headers;
    • API网关保留 x-emas-gw- 为前缀的header作为自有协议header,除了 统一鉴权场景 规定使用 x-emas-gw-auth-ticket 以外,请勿添加其它以 x-emas-gw- 为前缀的header;

测试1

测试2

请求结果解释

点击测试按钮,如果请求通过,就可以看到响应信息了。

  • 请求URL:前端模拟请求具体的URL,请忽略这个URL中的域名,它是内部域名,不能直接用于端上接入;

  • 请求Header:前端模拟请求时携带的具体header,供参考;

  • 响应码:HTTP请求的响应;

  • 响应Header:HTTP请求的响应header;其中,x-emas-gw- 为前缀的header是协议保留header,如

    • x-emas-gw-retcode:API网关的结果code;为SUCCESS表示成功,其它为失败并且表明失败原因;
    • x-emas-gw-retmsg:API网关的结果msg,是retcode的具体说明;
  • 响应Body:HTTP请求的响应Body,即业务后端的真实响应内容,要求为JSON格式,这里会做具体的解析和pretty展示。

测试响应