# pc-mock
> Get a full fake REST API with zero coding to mock
Latest version **0.3.4** (published 2019-04-04) · MIT license · 0 weekly downloads
## Install
```sh
npm install pc-mock
pnpm add pc-mock
yarn add pc-mock
bun add pc-mock
```
Provides the command `pcmock`.
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.3.4 |
| Published | 2019-04-04 |
| First published | 2018-08-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=7.6 |
| Dependencies | 9 |
| Unpacked size | 15.3 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | vdorchan |
| Maintainers | vdorchan |
## Links
- npm: https://www.npmjs.com/package/pc-mock
- Repository: https://github.com/vdorchan/pc-mock
- Homepage: https://github.com/vdorchan/pc-mock#readme
- Issues: https://github.com/vdorchan/pc-mock/issues
- npm.io page: https://npm.io/package/pc-mock
## Dependencies (9)
- [koa](https://npm.io/package/koa.md) ^2.5.2
- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [yargs](https://npm.io/package/yargs.md) ^12.0.1
- [mockjs](https://npm.io/package/mockjs.md) ^1.0.1-beta3
- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.2
- [@koa/cors](https://npm.io/package/@koa/cors.md) ^2.2.2
- [koa-jsonp](https://npm.io/package/koa-jsonp.md) ^2.0.2
- [portfinder](https://npm.io/package/portfinder.md) ^1.0.19
- [koa-bodyparser](https://npm.io/package/koa-bodyparser.md) ^4.2.1
## Recent versions
- 0.3.4 (latest) — 2019-04-04
- 0.3.3 — 2019-04-04
- 0.3.1 — 2019-04-03
- 0.3.0 — 2019-04-03
- 0.2.0 — 2018-11-09
- 0.1.4 — 2018-08-17
- 0.1.3 — 2018-08-17
- 0.1.2 — 2018-08-16
- 0.1.1 — 2018-08-16
- 0.1.0 — 2018-08-16
- 0.0.9 — 2018-08-16
## README
pc-mock
[![NPM version][npm-image]][npm-url]
[![NODE version][node-image]][node-url]
## 介绍
挺久以前，学了点 node，就利用它搭建了个很简陋的本地服务器，用来做专题调试接口，很简陋，但是很方便。
很多童鞋喜欢在专题 js 文件里加上接口的数据代码进行调试，那把代码搞得太乱了，另外也很容易把接口的数据逻辑暴露出去，不大安全。
于是乎，这两天重构了下代码，封装了一下，发布到 npm 上。
使用 pc-mock，会在你本地创建一个服务器，读取本地的接口文件，利用开发给的接口文档，可以很方便的转换出 json 文件。
我很懒，所以对我来说，工具一定要方便简单。相信我，只要花几分钟看完 readme，你绝对就会使用了。
使用 pc-mock，你的开发效率将会大大的提高，会减少很多调试接口带来的麻烦。
## 快速开始
全局安装 pc-mock（不能科学上网的，用cnpm安装）
```javascript
npm install -g pc-mock
```
或
```javascript
yarn global add pc-mock
```
根据开发提供的接口文档，创建一个 project.json 文件。
其中，文件名为项目名，键名为接口名，值为接口返回内容。
```json
{
"getUserInfo": {
"code": 1,
"msg": "获取成功",
"id":2, //用户id
"chance":1, //剩余抽奖次数
"lotteryTimes":1 //已抽次数
},
"lottery": {
"code": 1,
"msg":"恭喜中奖/未中奖",
"isAward": 1, //是否中奖0否1是
"amount": 8.88 //红包金额
}
}
```
或者使用 CommonJS 规范创建 project.js 文件，支持格式更加完美，支持完整的 Mock.js
```javascript
module.exports = {
"getUserInfo": {
"code": 1,
"msg": "获取成功",
"id":2, //用户id
"chance":1, //剩余抽奖次数
"lotteryTimes":1 //已抽次数
},
"lottery": {
"code": 1,
"msg": function () {
return this.code ? '恭喜中奖' : '未中奖'
},
"isAward": 1, //是否中奖0否1是
"amount": 8.88 //红包金额
}
}
```
开启 pc-mock
```bash
pcmock --port 8080
```
链接将参照你的本地文件路径，假如是在 project.json 所在文件夹执行的命令
那么现在打开浏览器，输入[http://localhost:8080/project/getUserInfo.jsp](http://localhost:8080/project/getUserInfo.jsp),你就可以获取到相应的数据了
```json
{
"code": 1,
"msg": "获取成功",
"id":2,
"chance":1,
"lotteryTimes":1
}
```
在你的专题文件中可以这么用，根据情况切换链接
```javascript
const ACTION_URL = '//localhost:8080/project/'
// const ACTION_URL = '//dev58.pcauto.com.cn/auto180610/action/'
// const ACTION_URL = '//play9.pcauto.com.cn/auto180610/action/'
$.get(`${ACTION_URL}getUserInfo.jsp`, res => {
// ...
})
```
最好再了解以下几点：
- json 格式本身是不能包含注释的，但接口文档一般带注释，并且注释还是有点作用的，于是我就允许了注释的存在，然后在访问接口的时候，使用一些代码去消除它。
- 另外，工具提供了将接口文档转换为 json 文件的功能，只需传入接口文档的链接，就能生成相应的 json 文件。注意：接口文档并不完全规范，所以处理完之后，有必要去进行一些检查改正。
- 接口链接安装本地的文件路径，做好本地 json 文件的组织。
- 本地服务器开启后，修改 json 文件是不需要重启服务器的，只需刷新接口或者重新访问即可获取到新的数据。
## Mock
内置了 mock.js， 支持使用 mock 的数据模版定义，可以更加方便的伪造各种数据。参考：[http://mockjs.com/examples.html#DPD](http://mockjs.com/examples.html#DPD)
```json
"getLottery": {
"code|0-1":1
}
```
访问接口，接口返回：
```json
{
"code":0
}
```
或
```json
{
"code":1
}
```
## 分页加载
创建的接口支持分页功能，按照公司规范，参数名分别为 pageNo 和 pageSize。
```json
"getLottery": {
"code":1,
"msg":"获取成功!",
"awardList|10":[ {
"name":"测试",//中奖人名字
"awardName":"8.88红包", //奖品名
"headImgUrl":"https://tfs.alipayobjects.com/images/partner/T1SGRfXgJbXXXXXXXX" //头像
}
]
}
```
从上面的 json 文件中，为了能让工具知道哪个是列表参数，使用了 mock 的数据模版进行定义，其中 10 是列表默认的数量，即默认的 pageSize
```javascript
'name|count': array
```
另外，还可以在 json 文件中使用 $pn 和 $ps 占位符， 接口返回时，将会使用 pageNo 和 pageSize 进行替换。
```json
"getLottery": {
"code":1,
"msg":"获取成功!",
"awardList|10":[ {
"name":"测试$ps",//中奖人名字
"awardName":"8.88红包$pn", //奖品名
"headImgUrl": "https://tfs.alipayobjects.com/images/partner/T1SGRfXgJbXXXXXXXX" //头像
}
]
}
```
访问 [http://localhost:8080/project/getLottery.jsp?pageNo=2&pageSize=3](http://localhost:8080/project/getUserInfo.jsp?pageNo=2&pageSize=3)
接口返回:
```json
"getLottery": {
"code":1,
"msg":"获取成功!",
"awardList|10":[{
"name":"测试3",
"awardName":"8.88红包2",
"headImgUrl": "https://tfs.alipayobjects.com/images/partner/T1SGRfXgJbXXXXXXXX"
},
{
"name":"测试3",
"awardName":"8.88红包2",
"headImgUrl": "https://tfs.alipayobjects.com/images/partner/T1SGRfXgJbXXXXXXXX"
},
{
"name":"测试3",
"awardName":"8.88红包2",
"headImgUrl":" https://tfs.alipayobjects.com/images/partner/T1SGRfXgJbXXXXXXXX"
}
]
}
```
## 命令行使用
```bash
pcmock [options]
选项：
--port, -p 设置端口号 [默认值: 3000]
--delay, -d 延迟接口响应的时间
--turnDoc, -t 传入开发文档的链接和json文件名（可选，默认以第一级目录名），自动将其转换为json文件
--help, -h 显示帮助信息 [布尔]
--version, -v 显示版本号 [布尔]
示例：
pcmock --port 8080
pcmock -p 8080 -d 1000
pcmock -t http://dev58.pcauto.com.cn/auto180610/action/help.jsp bmw.json
https://github.com/vdorchan/pc-mock
```
## License
MIT - [Typicode](https://github.com/typicode) - [Patreon](https://www.patreon.com/typicode)
[npm-url]: https://www.npmjs.com/package/pc-mock
[npm-image]: https://img.shields.io/npm/v/pc-mock.svg
[node-url]: https://nodejs.org/en/download/
[node-image]: https://img.shields.io/node/v/pc-mock.svg
---
_Source: https://npm.io/package/pc-mock · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._