macondo-mock v2.4.1

macondo-mock

macondo 是百年孤独中的一个地名，译作马孔多。

本地的一种接口 mock 方案，在得到接口的 swagger 文档之后生成本地 mock 接口服务，方便本地调试使用。

使用场景

1. 服务端接口定义好了，但是没有具体实现好或是不能调用的时候，用本地 mock 代替。
2. 查询类数据，服务端接口数据可能不够充足，不方便页面调试，本地 mock 就能很好解决。
3. 在离线环境、网络不稳定的情况下方便调试。

使用

安装

可在项目中安装，也可全局安装，推荐项目内部安装。

yarn add macondo-mock

用法

如果全局安装，进入到项目，终端运行 macondo-mock，在项目内使用可以在 package.json 中加入一个 scripts ：

{
    "scripts": {
        "mock": "macondo-mock"
    }
}

也可以免安装使用，支持 npx 的环境可直接在项目路径下：

npx macondo-mock

默认会在项目中生成一个 mock 目录，里面包含 swagger、schema 文件夹，并且提示缺少必要文件错误，在 swagger 文件夹中加入复制出来的 swagger 文档，如userInfo.sg。 再次调用脚本，就能自动生成 schema 文件以及 db.json 文件。访问 http://localhost:3000/userInfo 就能调用接口，注意这里的 接口命名是根据swagger文件名来命名 的。

如果需要产生多层目录的接口，可以在 swagger 文件夹下面加入对应的文件夹，这样就能根据文件夹名称生成多级目录。

例子：

/swagger/search.sg -> http://localhost:[port]/search

/swagger/path1/list.sg -> http://localhost:[port]/path1/list

/swagger/path1/path2/detail.sg -> http://localhost:[port]/path1/path2/detail

配置化

macondo-mock 是高度可配置化，如同babel、typescript、jest 的配置文件一样，可以在 package.json 中加入 "macondo-mock" 字段，或者是新建 macondo-mockrc.yaml、macondo-mockrc.yml、macondo-mockrc.json、macondo-mockrc.js、macondo-mock.config.js 写入配置项。 同时包含了默认设置，可做到开箱即用。

配置项

• baseOption
• schemaOption
• dbOption
• serverOption

baseOption

schemaOption

Iglobal:

export interface Iglobal {
        number?: string
        array?: string
        string?: string
        boolean?: string
    }

默认值如下：

const global = {
            number: '@integer(1, 10000)',
            string: '@csentence',
            boolean: '@boolean',
            array: '@integer(0, 10)'
        }

Isurmise:

export interface Isurmise {
    test: string
    mock?: string | {regexp: string}
    data?: string
    length?: number
}

这里的 test 的内容是正则字符串，内部是通过 new Regexp(test) 返回的正则去匹配字段名。

dbOption

serverOption

interfaceName 的规则和 webpack 的 output 的 name 字段类似，举个例子，传入[name].json，那么生成的接口名字最后会替换掉 [name] 内容。

schema 字段解释

schema 文件夹下的文件是生成最后的 db.json 的规则：

其中 mock 项还可以传入一个对象，传入正则(正则内容需要转义)生成假数据：

{
    "mock": {
        "regexp": "\\d{11}"
    }
}

获取 mock 类型

假数据由 mockjs 生成，需要更改预设值，直接修改 schema.json 文件的 mock 字段。

默认 mock 类型

常用 mock 类型

默认的 mock 类型不可能在所有场景都能很好使用，这里列举常用的 mock 类型：

覆盖默认 mock 数据

对于基本类型的数据，给 data 字段赋值就能覆盖mock数据，数组长度只需覆盖 length字段就能固定长度。

用例

点击这里查看使用用例。

注意事项

自动生成的 db.json 是做为最直接数据源生成接口数据，由于所有的接口全部生成在这个 json 文件中，这个文件会非常大，避免直接去修改 db.json 来改动接口数据。 如需固定某个字段返回值，可在 schema.json 文件对该字段的 data 字段修改为需要固定的数据。

默认schema.json、db.json数据只会生成一次