Mocks Server · node.js mock server

Mocks Servernode.js mock server

Simple and easy out-of-the-box
Very powerful and customizable with plugins
Integrates with other development tools

Isolated front-end development

Define api contracts, add mocks-server fixtures and start front-end development. Don't wait for the api to be ready. Front-end and back-end teams can work in parallel, avoiding delays.

Multiple api behaviors

Define multiple api behaviors easily, including error cases. Ensure that your front-end application is ready for all cases. Change the behavior of the server while it is running using one of the available plugins.

Solid tests

Test your front-end application configured for making requests to mocks-server. Same tests can be reused to run end to end tests with the real api in more advanced phases of integration, learn how.

Easy to use

Install it and start it in seconds. Follow the tutorial to add fixtures and you'll have a simulated api in few minutes.

Create a configuration file, or use one of the included plugins, as the inquirer CLI or the admin API REST for changing settings easily while it is running.

npm i --save-dev @mocks-server/main

Add the script to the package.json file:

{
  "scripts": {
    "mocks": "mocks-server"
  }
}

Maintainable

Maintain your fixtures organized and group them in different behaviors.

Behaviors can be created extending from another ones, so you can modify or add new fixtures to the main behavior, and the rest of behaviors will inherit them.

[
  {
    "id": "standard",
    "fixtures": ["get-user", "update-user"]
  },
  {
    "id": "update-user-error",
    "from": "standard",
    "fixtures": ["update-user-error"]
  }
]

Flexible and customizable

From defining fixtures using express middlewares to developing your own plugins or even adding new fixtures handlers, the mocks-server is very adaptable to achieve any project requirements.

Plugins from NPM or your own plugins can be added easily using the configuration file.

class Plugin {
  constructor(core) {
    core.addSetting({
      name: "traceBehaviors",
      type: "boolean",
      description: "Trace behaviors changes",
      default: true
    });

    this._core = core;
    this._onChangeMocks = this._onChangeMocks.bind(this);
    this._onChangeSettings = this._onChangeSettings.bind(this);
  }
  // ...
}

Integrations

There are available packages for integrating the Mocks Server with other development tools.

For example, @mocks-server/cypress-commands allows to easily control the mock server from Cypress. Read the Cypress integration chapter for further info

describe("user with admin role", () => {
  before(() => {
    cy.mocksServerSetBehavior("admin-user");
    cy.visit("/");
  });

  it("should see the users section link", () => {
    cy.get("#users-section-link").should("be.visible");
  });
});

Upcoming features

Administration web user interface, Chrome extension, Proxy fallback, Web Sockets, store your fixtures in a remote host, etc.
Check the github project to stay up to date on what we are working.