easy-mock 2021.3.5rc4

Generate mock service according to the YAML/JSON file in the current directory

Easy Mock

设计目标

• 高效：只需PB文件就可以快速生成Mock Server
• 易用：不需要懂代码，直接编辑配置文件定义待Mock接口

v 1.0 主要功能

• 根据PB生成需要Mock的接口
  • 支持每个接口生成到单独的配置文件或生成到一个文件
  • 生成接口提供默认的Response
• Response随机数据生成
• 支持命令行配置参数
• 支持ini配置文件
• 支持输入yaml文件和目录

To Do

• 支持Swagger定义的接口文件
• 支持Json/Yaml配置文件
• 支持Request,Response schema存放在单独的文件
• 支持多个端口

参考文档

• http://json-schema.org/
• JSON Schema入门 https://www.jianshu.com/p/1711f2f24dcf?utm_campaign=hugo

安装

pip install easy-mock

使用

查看版本号

$ easy_mock --version
2021.2.25rc4

查看帮助

$ easy_mock -h
usage: easy_mock [-h] [-V] [-p PORT] [-pb2y TO_YAML] [-pb2j TO_JSON]
                 [pb_source_file]

Generate mock service according to the YAML/JSON file in the current directory

positional arguments:
  pb_source_file        Need converted pb source file.

optional arguments:
  -h, --help            show this help message and exit
  -V, --version         show version
  -p PORT, --port PORT  Port that needs mock service.
  -pb2y TO_YAML, --pb-to-yaml TO_YAML
  -pb2j TO_JSON, --pb-to-json TO_JSON

示例

新建并切换到目录

$ mkdir test
$ cd test

编写YAML/YAM文件(easy_mock会加载当前目录下所有以.yml/.yaml结尾的文件)

apis:
  - url: login/mcw # 接口路径
    method: POST # 接口方法
    request_schema: # 请求jsonschem 不传则不做输入合法性校验
        {
          "type": "object",
          "properties": {
            "username": {
              "type": "string"
            },
            "password": {
              "type": "string"
            },
          },
          "required": [
            "username",
            "password"
          ]
        }
    response_schema: # 响应jsonschem, 根据schema生成mock数据  response_schema 和 defined_data_list必须有一个匹配
        {
          "type": "object",
          "properties": {
            "code": {
              "type": "integer", # 数据类型
              "maximun": 100, # 数据范围 最大
              "minimun": 1 # 数据范围 最小
            },
            "msg": {
              "type": "string"
            },
            "token": {
              "type": "string"
            },
          },
          "required": [   # 若指定required, 则每次必定返回 code、 msg字段, token字段则随机返回
            "code",
            "msg"
          ]
        }
    defined_data_list: # 自定义返回 如果请求体于list中的body匹配， 则返回对应的response  response_schema 和 defined_data_list必须有一个匹配
        [
          {
            body:{"username":"edison", "password":"123"},
            response:{"code":-1, "msg":"密码输入不正确"}
          },
          {
            body:{"username":"lily", "password":"123"},
            response:{"code":-2, "msg":"用户名不存在"}
          },
          {
            body:{"username":"root", "password":"123"},
            response:{"code":1, "msg":"登录成功", "token":"5lCadRru(ADn2IE!$LV%x%JF3JNmz*Nf5nFieUG!r((&esi2CLI$jb!227Lh"}
          },
          {
            body:{"username":"lily"},
            response:{"code":-1, "msg":"密码是必填的"}
          },
          {
            body:{"password":"123"},
            response:{"code":-1, "msg":"用户名是必填的"}
          }
        ]

  # 最精简写法
  - url: login/mcw # 接口路径
    method: GET # 接口方法
    defined_data_list: # 自定义返回 如果请求体于list中的body匹配， 则返回对应的response
      [
        {
          body:{"username":"edison", "password":"123"},
          response:{"code":-1, "msg":"密码输入不正确"}
        }
      ]

运行

$ easy_mock -p 9000
 * Serving Flask app "easy_mock.core" (lazy loading)
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: off
 * Running on http://0.0.0.0:9000/ (Press CTRL+C to quit)

调用mock接口

根据 response schema 返回随机数

$ curl -X POST 'http://172.20.25.168:9000/login/mcw' -d '{"username":"zhangsan", "password": "123"}' | python -m json.tool
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   173  100   131  100    42   7440   2385 --:--:-- --:--:-- --:--:--  7705
{
    "code": 93,
    "msg": "qwWtdNaSuTbDYzSAODvBGvrrYaUPkXejjSdWmcnVtxKJsuwIPzFwGzSFBFPiKqAXGjUPClpVUKzXFVsFFNUPC",
    "token": "nLqGauEqZotIsq"
}


匹配自定义返回值

curl -X POST 'http://172.20.25.168:9000/login/mcw' -d '{"username":"root", "password": "123"}' | python -m json.tool
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   153  100   115  100    38   6477   2140 --:--:-- --:--:-- --:--:--  6764
{
    "code": 1,
    "msg": "登录成功",
    "token": "5lCadRru(ADn2IE!$LV%x%JF3JNmz*Nf5nFieUG!r((&esi2CLI$jb!227Lh"
}

定义 json schema

修改 response schema:

      response_schema: 
        {
          "type": "object",
          "properties": {
            "code": {
              "type": "integer", 
              "maximun": 10, # 修改数据范围 为 0-1
              "minimun": 1 # 修改数据范围 为 0-1
            },
            "msg": {
              "type": "string"
              "maxLength": 10, # 修改string长度为 5-10
              "minLength": 5 # 修改string长度为 5-10
            },
            "token": {
              "type": "string"
            },
          },
          "required": [  
            "code",
            "msg"
          ]
        }

调用mock接口

$ curl -X POST 'http://172.20.25.168:9000/login/mcw' -d '{"username":"zhangsan", "password": "123"}' | python -m json.tool
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   182  100   140  100    42   7931   2379 --:--:-- --:--:-- --:--:--  8235
{
    "code": 1,
    "msg": "Nlgedsc",
    "token": "sImDahqhaSKuosjXbFlcTAanzvV"
}

自定义扩展

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

$ touch processor.py
$ vim processor.py

def test(req, resp): 

    resp["username"] = req.get("username")

    return resp

在YAML/YAM文件接口详情中新增setup or teardown方法

group:
  group_name: 用户
  group_desc: 用户登录系统、退出登录系统
  order: 1
  apis:
    login/mcw: 
      name: 用户登录
      desc: 用户登录成功，接口会返回一个token
      method: POST 
      body_mode: json
      setup: # setup 接受一个参数, 对请求题做前置操作, 例如加解密等
      teardown: test # teardown两个参数, 对请求体和响应体做后置操作, 例如响应体包含请求体中某一字段

      # setup、teardown 均可不填或留空

调用mock接口

$ curl -X POST 'http://172.20.25.168:9000/login/mcw' -d '{"username":"zhangsan", "password": "123"}' | python -m json.tool
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   136  100    94  100    42   5135   2294 --:--:-- --:--:-- --:--:--  5222
{
    "code": 2,
    "msg": "gmBiSDVlixdNqntqciZHkyHwsLglpw",
    "token": "ZeyZODPPxnd",
    "username": "zhangsan"
}