EasyMock使用

EasyMock优势
1. 省去配置、安装mockJs步骤，解决多人协作Mock数据不互通问题
2. 不需要在项目中写多余的代码，例如将Mock 数据写在代码里、json文件里

• 平台默认创建了一个演示项目，打开如下：

  使用时建议和后台返回的数据一样

• 创建接口

  EasyMock的写法和Mock.js一模一样
  Mock.js语法

  • 基础语法

    {
      "status": 0,
      "list|1-4": [{
        "id": "@id",
        "name": "@cname",
        "IP": "@ip",
        "email": "@email",
      }]
    }
  

  • Function使用

  {
    "status": 0,
    name: function({ _req }) {
      return _req.query.name
    },
    data: function({ _req, Mock }){
  
      return _req.query.name ? {
        id: Mock.mock("@id()"),
        cname: Mock.mock("@cname()"),
      } : {}
    },
    "list|1-4": [{
      "id": "@id",
      "name": "@cname",
      "IP": "@ip",
      "email": "@email",
    }]
  }
  

  • Function 参数说明

    字段	描述
    Mock	Mock 对象
    _req.url	获得请求 url 地址
    _req.method	获取请求方法
    _req.params	获取 url 参数对象
    _req.querystring	获取查询参数字符串(url中?后面的部分)，不包含 ?
    _req.query	将查询参数字符串进行解析并以对象的形式返回，如果没有查询参数字字符串则返回一个空对象
    _req.body	当 post 请求以 x-www-form-urlencoded 方式提交时，我们可以拿到请求的参数对象
    _req.path	获取请求路径名
    _req.header	获取请求头对象
    _req.originalUrl	获取请求原始地址
    _req.search	获取查询参数字符串，包含 ?
    _req.host	获取 host (hostname:port)
    _req.hostname	获取 hostname
    _req.type	获取请求 Content-Type，不包含像 "charset" 这样的参数
    _req.protocol	返回请求协议
    _req.ip	请求远程地址
    _req.get(field)	获取请求 header 中对应 field 的值
    _req.cookies(field)	获取请求 cookies 中对应 field 的值

• 自定义响应

  • 当定义的数据结构中包含 _res 字段的时候，会进入一个特殊逻辑，可以给返回的请求添加一些定制信息。

    字段	描述
    status	可以定制返回的 http status code，默认是 200
    cookies	可以定制需要设置的 cookie（暂时不支持设置过期时间等）
    headers	可以定制返回的 response 的 header
    data	如果有这个字段，会以此数据直接覆盖整个返回的数据，并且此处不支持 mock 的语法（如果 _res.status 的值为 200，则不会覆盖默认定义的 mock 数据）

    {
      "success": true,
      "data": {
        "default": "hah"
      },
      "_res":{
        "status": 400,
        "data": {
            "success": false
         },
        "cookies": {
          "test": "true"
        },
        "headers": {
          "Power": "easy-mock"
        }
      }
    }
  

  以此定义为例，当 _res.status 的值为 400 的时候，用户端接收到的响应将会是 _res.data 中定义的数据，并且返回一个 status code 为 400 的响应，响应的 header 中会包含一个叫做 Power 的值，并为浏览器设置一个叫做 test 的 cookie。

  当你想要返回正常的 mock 数据的时候，修改 _res.status 为 200，或者将整个 _res 删掉即可。