YAPI高级Mock使用文档

一、进入YAPI高级Mock

进入接口详情页，点击『高级 Mock』选项。

image
YAPI的高级Mock 支持Mock期望和自定义Mock脚本两种方式

二、Mock期望的使用

添加期望

• 1、期望基本信息
  

  image
  期望名称：给此条期望命名
  IP 过滤：请求的 IP 是设置的地址才可能返回期望。默认 IP 过滤关闭，任何 IP 地址都可能返回期望。
  参数过滤：请求必须包含设置的参数，并且值相等才可能返回期望。参数可以在 Body 或 Query 中。

• 2、期望响应
  

  image
  HTTP Code：期望响应的 HTTP 状态码（可以自己设置任意错误状态调试）
  延时：期望响应的延迟时间 （可设置接口返回时间做特殊测试）
  HTTP 头：期望响应带有的 HTTP 头
  返回 Body：期望返回数据 （支持mock写法）

管理期望

image
期望添加成功后在期望列表可以管理，一个接口可以有多条期望（参数需要不重复）

调用接口

image
直接调用Mock地址即可
image

三、自定义Mock脚本

YApi 提供了写JS脚本方式处理这一问题，可以根据用户请求的参数修改返回内容。
脚本主要由两部分组成全局变量和响应
[图片上传失败...(image-47a5bf-1631871972393)]

全局变量[相当于期望中的基本信息]

• header 请求的 HTTP 头
• params 请求参数，包括 Body、Query 中所有参数
• cookie 请求带的 Cookies

响应

• mockJson 接口定义的响应数据 Mock 模板
• resHeader 响应的 HTTP 头
• httpCode 响应的 HTTP 状态码
• delay Mock 响应延时，单位为 ms
• Random Mock.Random 方法，可以添加自定义占位符,详细使用方法请查看 Wiki

使用方法

首先开启此功能
Mock 脚本就是用 JavaScript 对 mockJson 变量修改,请避免被全局变量(httpCode, resHeader, delay)的修改

Mock 优先级说明

请求 Mock 数据时，规则匹配优先级：Mock 期望 > 自定义 Mock 脚本 > 项目全局 mock 脚本 > 普通 Mock。

YAPI详细使用文档

https://hellosean1025.github.io/yapi/documents/index.html