Skip to content

Commit

Permalink
chore: 更新 server 中的 readme 及 package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
wll8 committed Dec 3, 2020
1 parent e2af1b0 commit 25cfbbc
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 7 deletions.
21 changes: 17 additions & 4 deletions server/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# mockm
一款便于使用, 功能灵活的接口工具.

QQ交流群: [62935222](https://qm.qq.com/cgi-bin/qm/qr?k=4rvOknpHyqs5wd3c2kEt34Eysx83djEZ&jump_from=webapi)

## 特性
- 0 侵入, 无需修改项目中的任何代码即可投入使用
- 快速生成接口和数据, 以及文档
Expand All @@ -18,10 +20,21 @@
- 跨平台, 支持 linux macos windows
- 支持远程调试, 一个属性完成内网穿透

## 安装和使用
``` sh
npm i -g mockm
mm proxy=http://example.com/
## 快速开始
1. 命令行输入 `npm i -g mockm` 安装
2. 创建配置文件 `mm.config.js` 并录入内容
``` js
module.exports = {
api: {
'/my/api': {msg: `我的 api`},
},
}
```
3. 命令行输入 `mm` 启动

所有工作已经完成了, 请享用:
- 浏览器访问 http://127.0.0.1:9000/my/api 查看效果.
- 浏览器访问 http://127.0.0.1:9005/#/get/my/api 请求详情.
- 想了解更多功能请继续阅读...

文档: https://www.hongqiye.com/doc/mockm
26 changes: 23 additions & 3 deletions server/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,27 @@
"start:page": "cd page && browser-sync start --no-notify --server --files '**/**'",
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC"
"engines": {
"node": ">=12"
},
"os" : ["win32", "darwin", "linux" ],
"homepage": "https://hongqiye.com/doc/mockm/",
"keywords": [
"JSON",
"server",
"fake",
"REST",
"API",
"prototyping",
"mock",
"mocking",
"test",
"testing",
"rest",
"data",
"dummy",
"sandbox"
],
"author": "xw",
"license": "MIT"
}

0 comments on commit 25cfbbc

Please sign in to comment.