Mock介绍

YApi的 Mock 功能可以根据用户的输入接口信息如协议、URL、接口名、请求头、请求参数、返回数据（返回数据）生成 Mock 接口，这些接口会自动生成模拟数据，创建者可以自由构造需要的数据。

mock地址解析：YApi平台网址 + mock + 您的项目id + 接口实际请求path

假设你 YApi 的部署地址为：http://yapi.xxx.com 然后用这个地址作为示例

  1. mockd 地址： http://yapi.xxx.com/mock/29/api/hackathon/login

注：项目 id 可以在项目设置里查看到

定义 mock 数据示例

项目 -> 接口编辑 -> 返回数据设置

返回数据设置有两种方式，最新版本默认是基于 json+注释 的方式，另外一种是基于 json-schema 定义数据结构,请根据实际情况灵活选择使用。

方式1. mockjs

数据Mock - 图1

原理

基于 mockjs，跟 Mockjs 区别是 yapi 基于 json + 注释 定义 mock 数据，无法使用 mockjs 原有的函数功能。

  1. 正则表达式需要基于 rule 书写，示例如下：
  1. {
  2.   "name|regexp": "[a-z0-9_]+?",
  3.   "type|regexp": "json|text|xml"
  4. }
  1. 支持替换请求的 query, body 参数
  1. {
  2.   "name": "${query.name}", //请求的url是/path?name=xiaoming, 返回的name字段是xiaoming
  3.   "type": "${body.type}",   //请求的requestBody type=1,返回的type字段是1
  5. }
  1. 示例
  1. /**
  2.  * 这是一个接口返回数据示例
  3.  */
  5. {
  6.     "errcode": 0,
  7.     "errmsg": "@word",
  8.     "data": {
  9.         "id": "@id", //@id 随机生成 id
  10.         "name": "@name" //@name 随机生成用户名
  11.     }
  12. }

详细使用文档请查看：Mockjs 官网

方式2. json-schema

数据Mock - 图2

开启 json-schema 功能后，根据 json-schema 定义的数据结构，生成随机数据。

如何生成随机的邮箱或 ip(该方法在v1.3.22之后不再适用)？

数据Mock - 图3

点击高级设置，选择 format 选项，比如选择 email 则该字段生成随机邮箱字符串。

集成 mockjs

基本书写方式为 mock 的数据占位符@xxx, 具体字段详见Mockjs 官网 数据Mock - 图4 数据Mock - 图5

如果不是以@字符开头的话或者匹配不到Mockjs中的占位符就会直接生成输入的值

如何使用 Mock

1 在 js 代码直接请求yapi提供的 mock 地址（不用担心跨域问题）

在代码直接请求 yapi 提供的 mock 地址，以 jQuery 为例：

  1. let prefix = 'http://yapi.xxx.com/mock/2817'
  2. $.post(prefix+'/baseapi/path', {username: 'xxx'}, function(res){
  3.     console.log(res) //返回上图预览部分的数据
  4. })

2 基于本地服务器反向代理

优点:不用修改项目代码

2.1 基于 nginx 反向代理

  1. location /baseapi
  2. {
  3. proxy_pass   http://yapi.xxx.com/mock/2817/baseapi; #baseapi后面没有"/"
  4. }

2.2 基于 ykit mock功能

  1. {
  2.     pattern: /\/api\/(.*)/,
  3.     responder: 'http://yapi.xxx.com/mock/58/api/$1'
  4. }

上面通过正则匹配，将所有接口转到 http://yapi.xxx.com 上，比如 http://localhost/api/user/status 会成为 http://yapi.xxx.com/mock/58/api/user/status

详细使用指南: ykit-config-mock

2.3 基于 ykit Jerry 代理

假设您本地服务器访问地址是： http://xxx.com

数据Mock - 图6

具体用法如下：

  1. 清除本地配置的 hosts
  2. 下载 Chrome 插件 SwitchyOmega 点击“选项” => 新建情景模式 设置代理服务器 127.0.0.1 代理端口 999
  3. 启动 sudo ykit s -x 浏览器访问 http://127.0.0.1:1334/jerry
  4. 在 jerry 中重新配置 hosts
  5. 在 Jerry 中点击 URL MAP 并添加配置

详细使用指南: 代理工具

2.4 基于 Charles 代理

点击 Charles 工具栏下的 tools >> Rewrite Settings 填写如下信息：

数据Mock - 图7

mock请求严格模式

版本 v1.3.22 新增 mock 接口请求字段参数验证功能，具体使用方法如下：

  1. 打开 项目 -> 设置 开启 mock 严格模式

  2. 针对 query, form 中设置的必须字段会进行必填校验 数据Mock - 图8

  3. 针对 req_body_type 是json schema 格式的数据进行校验

数据Mock - 图9 数据Mock - 图10