Tool for running mock servers locally to faciliate frontend development.

• Create and run multiple HTTP and Web Socket servers instantly.
• Cover complex scenarios, including delays, backend error responses, custom headers etc.
• Run it locally or on shared resources, CI.
• Use GUI or REST to manage servers.

1. Installation
2. Usage
3. Introduction
   1. Behaviours
   2. Events
   3. Reactions
4. Adding server
5. Adding behaviour
   1. Behaviour configuration
   2. Event configuration
   3. Reaction configuration
6. Fallback mode
7. Development
8. Test

Install from npm:

$ npm run install mock-office -g

$ mock-office [--gui]

It exposes:

• REST API: http://localhost:3060
• GUI: http://localhost:3070

Mock Office works like respository of mock servers. Idea was to have one common interface for spawning and managing HTTP and Web Socket servers.

You have two ways to interact with it.

• REST API
• GUI

Mocks are done by adding behaviours to servers. Behaviour is simply pair of event and reactions. Every type of server has its own accepted event types and reactions.

When something happens(e.g. incoming request, client connected to server) server generates event objects which are being compared with behaviour event requirements and if match succeeds then reactions trigger.

Reactions are simply server commands e.g. send a http response, start sending web socket messages.

POST /add-server

POST /add-behaviour

Fallback mode let you use your real API while mocking some endpoints not ready yet. This is done by mock server proxying request to fallback API when it can't find behaviour. Nevertheless when in fallback mode you can cover existing endpoints with mocked counterparts.

To start app development clone repo first and then:

$ npm i
$ npm run watch # runs webpack dev-server for GUI development
$ npm run serve-app # runs node app
$ npm run serve-app-with-gui # runs node app with GUI events server required for GUI being updated

To run tests:

$ npm run test