Skip to main content
Version: 2.3.0

Installing plugins

Plugins​

Plugins are a way of extending the functionality of Mocks Server.

Some things that can be made with a plugin are:

  • Load mocks or routes.
  • Listen to Mocks Server events and act in consequence.
  • Add custom express routers to the server.
  • Add new options, accessible even through command line arguments.
  • Change settings while the server is running.
  • Add new formats of defining route variants. (Using custom routes handlers)

How to install plugins​

Configuration file​

Use the configuration file for installing plugins:

// mocks.config.js
const FooPlugin = require("mocks-server-plugin-foo");

module.exports = {
  addPlugins: [FooPlugin],
  options: {
    mock: "foo-mock"
  }
};
note

Note the usage of the addPlugins property, not the plugins one. This is because the main distribution of Mocks Server (@mocks-server/main) already includes some plugins to improve the user experience. If you use plugins instead of addPlugins, all other plugins would be removed.

Programmatically​

If you are using the @mocks-server/core package to start Mocks Server programmatically, you can define the plugins to use as described in the programmatic usage chapter.

Find plugins​

Use the "mocks-server-plugin" tag to search Mocks Server plugins in NPM.