跳到主要内容

响应参数

响应区内默认返回实时响应结果,点击发送按钮后,如果有数据返回,则会显示返回数据,响应时间,响应码,Cookie等。同时我们支持将返回的响应结果保存为响应示例

警告

注意:返回数据默认是Pretty模式,便于查看 JSON XML 格式。您可以通过切换“原生”或“预览”模式 查看其它类型的类型。

image.png

a.校验返回结果

Apipost将以您在API设计页面内填写的响应期望作为判断标准,与API调试模块中请求接口所获得的响应内容进行对比,对指定期望返回的响应码、数据结构等进行校验。

如期望内容与响应内容一致,则会提示校验通过,即该接口返回的响应内容符合期望。当两者不一致时,会提示错误信息并标明具体部分,具体校验逻辑见下文。

校验逻辑

image.png

校验顺序分为以下五个步骤,若某一步未通过,则会停止下一步校验,并展示出当前校验结果。

  1. 第一步:对响应码进行校验,符合期望则进行下一步校验,不符合则会提示错误。
  2. 第二步:对内容格式(JSON、XML、 HTML、 Raw、 Binary)进行校验,不符合则会提示错误。
  3. 第三步:对参数名进行校验,存在该参数名则通过,不符合则会提示错误。
  4. 第四步:对参数值的类型进行校验,符合期望则通过,不符合则会提示错误。
  5. 第五步:对高级设置的内容进行校验,符合期望则通过校验,不符合则会返回具体字段的校验信息。

选择期望

我们可以在校验区,手动选择在API设计中建立的期望,来进行返回结果进行匹配校验;
image.png

b.新建示例

我们可以在API调试模块下新建一个示例,该示例与API设计中的期望是一一对应关系,每新建一个示例头,API设计模块中都会自动新建一个与之对应的期望。
点击“新建示例”,则会出现“新建示例”弹窗,我们可以在这里填写示例名、状态码和响应内容。 同时支持将返回结果直接导入至示例种

image.png