Skip to content

A simple mock server powered by Express

Notifications You must be signed in to change notification settings

greebamax/dataccino

Repository files navigation

A simple mock server powered by Express.js


Basic Usage

Specify route to handle requests:

/**
 * @file:route-handler.js
 */
// package provides Chance.js with predefined mixins
const chance = require('dataccino/config/setup-chance');

// package provides some useful helpers
const { Helpers } = require('dataccino/utils');

module.exports = (app, options) => {
  // app - an instance of Express application
  // options - parameters passed to the mock server
  app.get('/some-route', (req, res) => {
    // you can use standard Express API to specify custom handlers
    res.json({
      statusCode: 200,
      response: {
        someSentence: Helpers.generate(10, chance.word.bind(chance, { syllables: 3 }));
      }
    });
  });
};

Combine route handlers:

/**
 * @file:routes.js
 */
const someRouteHandler = require('path/to/route-handler'); // see above

module.exports = (app, options) => {
  someRouteHandler(app, options);
};

And pass handlers as a parameter to the mock server:

/**
 * @file:mock-server.js
 */
const { server: mockServer } = require('dataccino');
const routes = require('routes');

// start mock server
mockServer({
  routes: routes, // provide route handlers
  port: 8888, // specify port
  // any other options could be added here and might be used within handlers
});

Specify npm:start script

"scripts": {
  "start": "node ./path/to/mock-server.js"
}

About

A simple mock server powered by Express

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published