Skip to content

Latest commit

 

History

History
112 lines (86 loc) · 3.29 KB

README.md

File metadata and controls

112 lines (86 loc) · 3.29 KB
Raw

Mockman

中文文档

Build Status Build status

Mockman is a powerful and convenient tool that helps you to manage and start mock servers locally.

With the app, you can easily configure the routes, request format and response of a mock server

Screenshot

Mockman Logger

Usage

Feature

  1. Create your mock server - click the add button
  2. Configure the name, port and prefix of your move server, make sure the port is not in use, or Mockman will give you a error notification.
  3. Add some apis for your mock server.
  4. Configure the method, route, response code, latency, required request options and reponse data of each api.
  5. Start the server - click the start button.
  6. After all, you can test your api locally.

Where will your api data be stored?

Your data will be stored as a sqlite file absolutely on your local, the path will be different on different operation system.

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

Be attention before you start https server

  • Mockman is using self-signed-certification to create https server
  • Install rootCA on your client and trust it before you send https requests

Todos

Server

  • ipcMain && ipcRender communication
  • dababase support
  • create a new mock
  • update a mock
  • remove a mock
  • query a mock info
  • create an api
  • update an api
  • remove an api
  • query an api info
  • start an express server with a mock config
  • handle errors while starting the server

Client

  • brand header dislay
  • mock sider display
  • mock-detail and api-list display
  • api-detail display
  • create a new mock
  • update a mock
  • remove a mock
  • query a mock info
  • create an api
  • update an api
  • remove an api
  • query an api info
  • request params check list
  • response k-v input group
  • response code editor
  • add blur event to jsonEditor
  • add a log panel to show the logs of an active mock server process
  • add https support
  • group the apis with tag
  • check the conflict of all mocks
  • Export/Import mock or api configurations

License

license

Contribute

# 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