Easy Mock

• 本人有多年 UI 和接口自动化经验。可提供针对个人或公司级别的培训 QQ : 40690263
  • UI 自动化技术
  • 接口自动化技术
  • 接口 mock 技术
  • 测试工具定制开发

简单、易用的接口 Mock 工具

• 根据 Yaml 文件快速生成接口 Mock 服务
• 要求 python 版本 > 3.7

Yaml 文件示例

example.yml

apis:
  # 最精简写法
  - url: login # 接口路径
    method: POST # 接口方法
    defined_data_list: # 在此处定义request与response的匹配关系
      [
        {
          body: { "username": "edison", "password": "123" }, # request body
          response: { "code": -1, "msg": "密码输入不正确" } # response body
        }
      ]

安装

pip install easy-mock

启动 Mock Server

启动服务
easy_mock example.yml

调用接口
curl -H "Content-Type: application/json" -X POST 'http://127.0.0.1:9000/login' -d '{"username":"edison", "password": "123"}' | python -m json.tool

功能介绍

v 1.0 主要功能

• 根据 Yaml 文件内容返回 Mock 数据，两种方式：
  • 一、根据 request 内容返回 defined_data_list 中与之匹配的 response
  • 二、若 defined_data_list 未定义或无与 request 内容匹配的 response,则根据 response_schema 返回随机数据：
  • 支持的随机数据类型: bool, int, float, double, string
• 根据 PB(.proto) 生成 Mock 接口文件 (yml)
• 支持 http/https
• 支持对 request 和 response 做定制化处理（见自定义扩展）

查看帮助

$ easy_mock -h
usage: easy_mock [-h] [-v] [-p PORT] [-https] [-req] [-res] file_path

Generate mock service according to the YAML file

positional arguments:
  file_path      yaml configuration file, directory or .proto file

optional arguments:
  -h, --help     show this help message and exit
  -v, --version  show version
  -p             mock service port
  -https         enable mock server https protocol
  -req           generate request_schema in yaml
  -res           generate response_schema in yaml

自定义扩展

在当前目录下新建 python 文件 processor.py

$ touch processor.py
$ vim processor.py

# 函数命名无限制，在yaml指定函数名即可 
def xxx_setup(req): 

    req["username"] = "abc"

    return req

def xxx_teardown(req, resp):

    resp["age"] = 100

    return resp

在 YAML 文件中新增setup or teardown字段

apis:
  login:
    name: 用户登录
    desc: 用户登录成功，接口会返回一个token
    method: POST
    setup: xxxx_setup # 指定前置处理函数名，此函数接受一个参数, 对请求体做前置操作
    teardown: xxx_teardown # 指定后置处理函数名，此函数接受两个参数, 对请求体和响应体做后置操作

Yaml 文件示例及详解 (复杂写法)

- url: login # 接口路径
  method: POST # 接口方法
  request_schema: # （可选）用于对request body做合法性校验
    {
      "type": "object",
      "properties": {
        "username": {
          "type": "string"
        },
        "password": {
          "type": "string"
        },
      },
      "required": [
          "username",
          "password"
      ]
    }
  response_schema: # (可选) 根据schema生成response随机数据  response_schema 和 defined_data_list 二者不可全为空
    {
      "type": "object",
      "properties": {
        "code": {
          "type": "integer", # 数据类型
          "maximun": 100, # 数据范围 最大
          "minimun": 1 # 数据范围 最小
        },
        "msg": {
          "type": "string"
        },
        "token": {
          "type": "string"
        },
      },
      "required": [ # required中的字段，response中必须返回, token字段则随机返回
          "code",
          "msg"
      ]
    }
  defined_data_list: # 定义request与response的匹配关系  
    [
      {
        body: { "username": "edison", "password": "123" },
        response: { "code": -1, "msg": "密码输入不正确" }
      },
      {
        body: { "password": "123" },
        response: { "code": -1, "msg": "用户名是必填的" }
      }
    ]

将 PB 转换为 Yaml

参数为.proto 文件类型时生成 yaml 文件

easy_mock server.proto -res
输出server.yml

To Do

• 支持 Swagger 定义的接口文件
• 支持 Request,Response schema 存放在单独的文件
• 支持延时返回 (sleep 关键字)

参考文档

• Json schema 用法 http://json-schema.org/
• JSON Schema 入门 https://www.jianshu.com/p/1711f2f24dcf?utm_campaign=hugo
• python 打包及支持 pip 安装 https://blog.csdn.net/sinat_33718563/article/details/88928950
• python setup.py install