Apikit 自学日记:智能 Mock 规则

功能入口:API管理应用 / 公共资源菜单 / 智能 Mock 设置 二级菜单在编写API文档返回结果时,若参数字段和类型匹配智能Mock规则,系统则会自动填入对应的Mock值。该功能提供无感的快速mock值配置,减轻mock规则配置的工作负担。

智能Mock的匹配规则分两种类型:内置规则和自定义规则。

内置规则是一套完整的预置智能Mock规则,用户不可编辑具体的匹配规则,仅可整体启用或停用。内置规则有助于用户快速使用智能Mock能力。

自定义规则是用户自定义自由配置的智能Mock匹配规则,用户可以根据个性化需求创建、编辑和删除自定义规则。支持使用通配符、正则表达式、完全匹配的方式来匹配字段名。

开启/停用内置规则

1、进入应用级公共资源内的智能mock设置,可看到自定义规则模块和内置规则模块。

2、在内置规则模块右上角,有开启/停用内置规则的切换按钮。该按钮默认开启,点击按钮则工作空间内停用内置智能Mock规则。

3、点击页面标题下的保存按钮,变更方可生效。

添加/编辑自定义规则

1、进入应用级公共资源内的智能mock设置页。

2、在自定义规则模块中,点击底部最后一行中输入对应的数据即可添加新的自定义规则:

  • 数据类型:匹配的字段数据类型,必填。

  • 匹配方式:用于确认字段名称的匹配方式。默认为通配符,可选择通配符、正则表达式、完全匹配三种方式。

  • 匹配规则:可输入字段名称匹配表达式,必填。根据所选匹配方式输入对应的名称匹配表达式。

  • 匹配大小写:控制字段名称匹配时是否大小写敏感,默认为否。

  • Mock 规则:支持输入任意固定值或mockjs的占位符。当字段匹配智能Mock规则的数据类型和字段名称后,系统自动填入的mock值。

  • 备注:用于标注说明该智能匹配规则,仅展示于智能mock设置页。

  • 操作:当前仅提供删除操作。

3、完成自定义规则添加或编辑后,需点击页面标题下的保存按钮才会生效。否则刷新页面后当次编辑的数据会清空。

删除自定义规则

1、进入应用级公共资源内的智能mock设置页。

2、点击对应自定义规则右侧的删除操作按钮,即可进行删除。

3、点击页面标题下的保存按钮,变更方可生效。

规则优先级

  • 智能Mock中,自定义规则的优先级大于内置规则。若某个字段同时满足自定义规则和内置规则的匹配条件,则该字段的mock规则优先填入自定义规则的mock内容。(即自定义规则>内置规则)

  • 新创建的自定义规则优先级更高。若某个字段同时满足两个自定义规则的匹配条件,则该字段的mock规则优先填入较新创建的自定义规则的mock内容。(即新自定义规则>旧自定义规则)

猜你喜欢

转载自blog.csdn.net/qq_42107247/article/details/131536847