# data-mock

> 轻量级数据模拟服务

Latest version **2.2.1** (published 2022-07-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install data-mock
pnpm add data-mock
yarn add data-mock
bun add data-mock
```

Provides the command `dm`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.1 |
| Published | 2022-07-11 |
| First published | 2018-08-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 18 |
| Unpacked size | 47.3 KB |
| Known vulnerabilities | 0 (+4 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 10 |
| Author | fezzc |
| Maintainers | fezzc |
| Keywords | mock, data, apidoc |

## Links

- npm: https://www.npmjs.com/package/data-mock
- Repository: https://github.com/zhouzuchuan/data-mock
- Homepage: https://github.com/zhouzuchuan/data-mock#readme
- Issues: https://github.com/zhouzuchuan/data-mock/issues
- npm.io page: https://npm.io/package/data-mock

## Dependencies (18)

- [cors](https://npm.io/package/cors.md) ^2.8.5
- [glob](https://npm.io/package/glob.md) ^7.1.4
- [open](https://npm.io/package/open.md) ^6.4.0
- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [apidoc](https://npm.io/package/apidoc.md) ^0.17.7
- [assert](https://npm.io/package/assert.md) ^2.0.0
- [mockjs](https://npm.io/package/mockjs.md) ^1.0.1-beta3
- [address](https://npm.io/package/address.md) 1.0.3
- [express](https://npm.io/package/express.md) ^4.17.1
- [chokidar](https://npm.io/package/chokidar.md) ^3.0.2
- [inquirer](https://npm.io/package/inquirer.md) ^6.5.0
- [commander](https://npm.io/package/commander.md) ^2.20.0
- [lodash.set](https://npm.io/package/lodash.set.md) ^4.3.2
- [body-parser](https://npm.io/package/body-parser.md) ^1.19.0
- [cross-spawn](https://npm.io/package/cross-spawn.md) ^6.0.5
- [detect-port-alt](https://npm.io/package/detect-port-alt.md) ^1.1.6
- [update-notifier](https://npm.io/package/update-notifier.md) ^3.0.1
- [http-proxy-middleware](https://npm.io/package/http-proxy-middleware.md) ^0.19.1

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 2.2.1 (latest) — 2022-07-11
- 2.0.0-alpha.2 (alpha) — 2019-07-23
- 2.2.0 — 2022-06-21
- 2.1.0 — 2019-09-05
- 2.0.2 — 2019-08-15
- 2.0.1 — 2019-08-12
- 2.0.0 — 2019-07-23
- 2.0.0-alpha.1 — 2019-07-19
- 2.0.0-alpha.0 — 2019-07-19
- 1.3.2 — 2019-06-17
- 1.3.1 — 2019-06-16
- 1.3.0 — 2019-04-09
- 1.2.1 — 2019-03-27
- 1.2.0 — 2019-03-27
- 1.1.0 — 2019-02-26
- … 18 more at https://npm.io/package/data-mock/versions

## README

<div align="center">

```

██████╗ ███╗   ███╗
██╔══██╗████╗ ████║
██║  ██║██╔████╔██║
██║  ██║██║╚██╔╝██║
██████╔╝██║ ╚═╝ ██║
╚═════╝ ╚═╝     ╚═╝

轻量级数据模拟

```

</div>


<div align="center">

# DataMock

[![download](https://img.shields.io/npm/dm/data-mock.svg)](https://www.npmjs.com/search?q=data-mock)
[![npm](https://img.shields.io/npm/v/data-mock.svg)](https://www.npmjs.com/search?q=data-mock)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/zhouzuchuan/data-mock/master/LICENSE)

</div>

## 它是什么

-   旨在帮助广大泛前端开发人员，解决数据模拟、数据对接等开发瓶颈，提高开发效率
-   一款基于 [Express](https://github.com/expressjs/express) 的轻量级数据模拟服务
-   引入了业界优秀的数据模拟工具 [Mockjs](https://github.com/nuysoft/Mock)，如果你可以跳墙，也可以试试这个神器 [Faker.js](https://github.com/Marak/faker.js)、[chancejs](https://github.com/chancejs/chancejs)

## 优势

-   轻量，随起随用
-   支持自定义模拟请求参数响应回调
-   支持绑定 web 前端框架 [React](https://github.com/facebook/react)、 [Vue](https://github.com/vuejs/vue) 等，实现模拟功能
-   降低不可抗力带来的开发失落感，如：断网、停电、服务器挂掉等诸如此类 😁
-   了解后端逻辑，成为优秀的全栈开发大牛奠定思维逻辑基础

## 下载

建议全局安装，随起随用

**npm**

```bash
npm install -g data-mock
```

**yarn**

```bash
yarn add global data-mock
```

## 如何用

### 目标服务目录

该目录下的所有 js 文件都会被监听以及读取载入挂在到路由上，具体写法可以参考这个 [example](https://github.com/zhouzuchuan/dataMock/tree/master/example/db) 

> .开头的文件（如：.store.js）则会被载入到 node 中的 `global.DM` 对象上，主要是用来存储各个请求的默认数据，可以用来做更多好玩的东西，如：关联数据模拟等



目标服务目录的 js 格式，建议采用 es6 

PS: 请提前检测下自己电脑安装的 node 支持何种程度的 es6，可以使用这个工具来检测 [es-checker](https://github.com/ruanyf/es-checker)



数据格式：`[请求方式 请求接口]: 响应函数`

```js
// 模拟数据格式
['GET /test']: function(req, res) {
  return res.json({
    name: Random.cname(),
    time: Random.date()
  });
}
```



### 现代前端框架 [webpack](https://github.com/webpack/webpack) 中使用

#### 2.0 使用方法如下

```js

const DataMock = require('data-mock');
const path = require('path')

// ...

// webpack 中webpack-dev-server 配置
devServer: {
    //  绑定mock server
    after: server => {
      
      	new DataMock(server，{
            target: path.resolve(__dirname, './src/mocks/'),
          
            // 监控目录（这里声明的目录有变动，则服务数据刷新，主要用来监控api变动）
            // 如果不需要则不写
            // 和上面target一样，必须通过 path.resolve 找到相对于项目的真实路径，否则可能出现监控不准确
            watchTarget: []
        })
 
    };
}


```





#### 1.0使用方法

> `data-mock` 暴露一个方法 `bindServer`，用来绑定 [webpack-dev-server](https://github.com/webpack/webpack-dev-server) 暴露的 server 对象
>
> ```js
> 
> const { bindServer } = require('data-mock');
> const path = require('path')
> 
> // ...
> 
> // webpack 中webpack-dev-server 配置
> devServer: {
>     //  绑定mock server
>     after: server => {
>         bindServer({
>             server,
>             target: path.resolve(__dirname, './src/mocks/')
> 
>             // 监控目录（这里声明的目录有变动，则服务数据刷新，主要用来监控api变动）
>             // 如果不需要则不写
>             // 和上面target一样，必须通过 path.resolve 找到相对于项目的真实路径，否则可能出现监控不准确
>             watchTarget: []
>         });
>     };
> }
> 
> ```

`watchTarget` 搭配 [api-manage](https://github.com/zhouzuchuan/api-manage) 使用效果更佳



## 命令

### `server`

| CMD             | 缩写 | 介绍                         |
| --------------- | ---- | ---------------------------- |
| `--target`      | `-t` | 指定目标服务目录  (相对位置) |
| `--watchTarget` | `-w` | 监听目录                     |
| `--open`        | `-o` | 打开浏览器                   |
| `--port`        | `-p` | 指定端口 默认`1024`          |

 

```bash

# 当前目录为目标服务目录 并启动服务
dm server

# 指定mocks文件夹为目标服务目录 并启动服务
dm server -t ./mocks/

# 指定mocks文件夹为目标服务目录，并且监听api文件夹
dm server -t ./mocks/ -w ./api/

# 指定mocks文件夹为目标服务目录，并且监听api文件夹、指定端口为2000、打开浏览器
dm server -t ./mocks/ -w ./api/ -p 2000 -o

```

### `doc`

| CMD        | 缩写 | 介绍          |
| ---------- | ---- | ------------- |
| `--target` | `-t` | 指定api文件夹 |
| `--dist`   | `-d` | 监听目录，默认为api文件地址中生成的 `DM-DOC`     |



```bash

# 指定当前运行目录为api目录
dm server

# 指定api文件夹为api目录
dm doc -t ./api/

# 指定api文件夹为api目录，并且输出值docs文件夹中
dm doc -t ./api/ -d /docs

```





## License

[MIT](https://tldrlegal.com/license/mit-license)

#### 🎉🎉🎉🎉 如果您觉的还可以，求点个 star 🎉🎉🎉🎉

---
_Source: https://npm.io/package/data-mock · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._