Skip to content

Latest commit

 

History

History
112 lines (86 loc) · 3.33 KB

README_zh.md

File metadata and controls

112 lines (86 loc) · 3.33 KB

Mockman

README

Build Status Build status

Mockman 是一款强大且方便的用来本地开启和管理Mock服务的跨平台开源工具

凭借Mockman,你只需要简单的配置Mock服务的本地运行端口、路由、请求格式以及返回数据,即可开启自己的Mock服务

截图

Mockman Logger

使用

Feature

  1. 创建一个Mock服务 - 点击添加按钮
  2. 配置Mock服务的名字端口以及通用前缀,注意端口不能被占用,否则开启服务的过程中应用会有错误通知
  3. 给Mock服务创建一系列api接口
  4. 配置每个api的请求方式路由地址http响应码延时时间请求格式以及返回数据
  5. 启动服务 - 点击绿色箭头
  6. 至此,服务启动成功,即可请求Mock数据

Mock服务的api数据将会存储在哪?

所有数据都将会在完全在本地以sqlite的形式进行存储,存储的地址因平台不同而不同:

  • %APPDATA% for Windows
  • $XDG_CONFIG_HOME or ~/.config for Linux
  • ~/Library/Application Support for macOS

关于https需要注意的点

  • Mockman的https服务使用的是自签名证书
  • 在客户端请求mockman的https服务之前,需要安装根证书并信任

Todos

主进程

  • 主进程以及渲染进程间ipc通信
  • 本地数据库支持
  • 创建mock服务
  • 更新mock服务
  • 删除mock服务
  • 获取mock服务信息
  • 创建api
  • 更新api
  • 删除api
  • 获取api信息
  • 基于mock服务的配置开启本地服务(express)
  • 启动express服务中处理错误

渲染进程

  • 公用header
  • mock服务显示边栏
  • mock服务详情以及api列表显示边栏
  • api详情显示
  • 创建mock服务
  • 更新mock服务
  • 删除mock服务
  • 获取mock服务信息
  • 创建api
  • 更新api
  • 删除api
  • 获取api信息
  • 请求参数checkbox
  • 返回数据key-value键值对
  • http响应码编辑
  • jsonEditor组件暴露blur事件
  • 添加日志面板显示已开启的mock服务的请求日志
  • 增加https支持
  • 通过标签给api进行分类
  • 检查所有mock服务的冲突
  • 导出/导入mock或者api配置

协议

license

贡献

# install the dependencies 
npm install

# serve with hot reload at localhost:9080
npm run dev 

# build mockman
npm run build

# run unit tests
npm test 

# lint all JS/Vue component files in `src/`
npm run lint