good-mock
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.13 • Public • Published

    good-mock

    npm version

    简单好用的 数据 Mock 插件

    安装

    在项目根目录下安装

    $ yarn add good-mock -D

    使用

    根目录:

    根目录

    在项目根目录下新建文件夹 mock 目录(可拷贝这个文件),在新建 data 目录和一个配置文件 config.js(文件名必选为 config.js) data (可多级目录和多个 js 或 ts 文件)中 .js.ts 中文件格式如下: 其中 mock/data中参数是用于设置数据 mock 接口,以 k-v 的方式进行设置,接口的 HTTP 方法通过在 key 中进行指定,支持的 HTTP 方法有:['GET', 'POST', 'HEAD', 'PUT', 'DELETE', 'CONNECT', 'OPTIONS', 'TRACE', 'PATCH']

    步骤一

    mock/data/api.[tj]smock/data/user/api.[tj]s

    module.exports = {
    	// GET => method , /api/info/1 =>api path , 3000 => 数据返回时间,毫秒(ms),会覆盖配置的中 resTime
    	"GET /api/info/1 3000": {
    		name: "xxx"
    	},
    
    	"POST /api/info": {
    		file: "xxxx"
    	}
    };

    步骤二

    /mock/config.js(或/mock/config.ts ) 配置文件

    // mock 配置文件
    module.exports = {
    	host: "127.0.0.1", // host
    	port: 1234, // 端口
    	https: false, // 是否https 请求
    	resTime: 600 // 全局数据返回时间,毫秒
    };

    步骤三

    shell 中执行

    nodemon --watch mock --exec ts-node ./node_modules/.bin/good-mock (window运行可能有问题)
    or
    nodemon --watch mock --exec ts-node ./node_modules/good-mock/lib/index.js

    也可以在 package.json 中添加脚本执行

     "scripts": {
       "mock": "nodemon --watch mock --exec ts-node ./node_modules/good-mock/lib/index.js"
     }
    

    end npm run mock

    参数

    /mock/config.js(或/mock/config.ts ) 中可以接受如下参数:

    参数项 类型 是否可选 用途
    host string 设置数据 mock 服务地址,默认为 127.0.0.1
    port number 设置数据 mock 服务端口,默认为 1234
    https boolean 是否是 https (暂不可用)
    resTime number 全局请求后数据返回时间,毫秒,默认为 500

    发布

    提交版本

    1. 修订版本号:patch 不定时会进行日常 bugfix 更新。(如果有紧急的 bugfix,则任何时候都可发布)列:1.0.0 -> 1.0.1
    npm run patch
    1. 次版本号:minor 一个 feature 或多个 feature 同时发布,列:1.0.0 -> 1.1.0
    npm run minor
    1. 主版本号:major 含有破坏性更新和新特性,不在发布周期内,列:1.0.0 -> 2.0.0
    npm run major

    发布到 npm

    npm run pub

    Install

    npm i good-mock

    DownloadsWeekly Downloads

    7

    Version

    1.2.13

    License

    ISC

    Unpacked Size

    79.4 kB

    Total Files

    11

    Last publish

    Collaborators

    • chenjiajing23