跳到主要内容

API设计-期望响应预定义

提示

API设计的主要作用是为了预先定义接口请求参数以及响应期望并生成 Mock URL,如果您仅仅需要调试接口,直接进 API调试 模块即可,无需在 API设计 模块预先定义。

a.新建期望

在同一个接口里,由于我们对不同场景下返回的数据结构期望不同,我们可以通过设置多个期望的方式,来满足这个需求。 如图,点击【新建期望】即可打开新建期望的弹窗。我们可以选择该期望的状态码、填写期望名称、选择内容格式,填写触发条件(非必填),最后点击保存,该期望创建成功。

markdown picture

b.内容格式

我们可以选择JSON、XML、 HTML、 Raw、 Binary五种内容格式,其中JSON和XML格式可以通过增加字段节点来定义数据结构、字段类型、mock值和参数描述,并支持导入JSON、XML、JSON-schema格式的文件,预览已编辑好的数据,支持刷新生成的数据。 1、JSON格式:该格式的响应内容支持json-schema、mock.js两种各自独立的数据模式,我们可以选择一种方式建立期望,数据结构保存后,可以在响应示例中引用。

markdown picture 【json-schema模式】

markdown picture 【mock.js模式】

2、XML格式:我们可以在table中配置,同json-schema,数据结构保存后,可以在响应示例中引用。 markdown picture 【XML模式】

3、HTML、Binary格式:只展示格式名,不可手动配置内容,数据结构保存后,可以在响应示例中引用。 markdown picture markdown picture 【HTML、Binary格式】

c.字段类型

当我们选择json-schema或XML格式时,可以设置每一条字段的类型,分别为string、number、integer、array、object、Boolean、null、any八种类型,若需对该字段进行高级设置,不同的类型也对应不同的高级设置方法。

markdown picture

d.如何添加/删除字段

1、增加字段:默认展示root字段,当数据类型为object,点击root右侧加号,可增加兄弟节点或子节点;当数据类型为array,则自动增加一个string类型的子节点;当数据类型为string、integer、Boolean、Number、null、any,可增加兄弟节点。

markdown picture

2、删除字段:点击删除icon,直接删掉此字段(root根节点不能删除)

markdown picture

e.高级设置

我们可以对某个字段进行高级设置,定义该字段数据结构的具体细节,同时也支持以目录为作用域进行定义,如点击根目录的高级设置,则高级设置内容对该目录下所有字段有效。

当数据类型为string: markdown picture

当数据类型为integer: markdown picture

当数据类型为Boolean: markdown picture

当数据类型为array: markdown picture

当数据类型为object: markdown picture

当数据类型为Number: markdown picture

当数据类型为Null,则无高级设置。

当数据类型为oneOf: markdown picture

当数据类型为anyOf: markdown picture

当数据类型为allOf: markdown picture

f.智能期望

什么是智能期望

我们可以在智能期望中填写一些触发条件,并设置当满足/不满足该触发条件后,所启用的期望。开启智能期望后,Apipost会根据已设置的触发条件,匹配旗下的参数判断规则,若满足条件,则会启用预设的期望。

如何添加智能期望

1、我们可以添加多个触发条件,每个触发条件下支持填写多个子条件。

2、填写好该触发条件下的子条件后,需要选择一个已有期望,作为满足该触发条件后所启用期望。

3、当触发条件下的所有子条件都被满足时,该触发条件才会被视为已满足。

markdown picture

获取自动生成的Mock url

本地url:是在本地进行的mock服务,只在本地可见,如需分享需要关闭防火墙。 云端url:是在Apipost云服务上进行的mock服务,可以分享给他人,当关闭url链接后,分享出去的页面将不可见。

markdown picture