stub-server

0.1.4 • Public • Published

Stub server is node.js based server for mocking request. Simple configuration format (JSON), responses can be in different files and types.

Installation

npm i stub-server

Usage

Like server:

 
var stubServer = require('stub-server');
 
stubServer.config('configuration.json');
 
stubServer.run();
 

Middleware:

 
var stubServer = require('stub-server');
 
stubServer.config('configuration.json');
 
stubServer.requestHandler(req, res, next);
 

Other usage examples are here

Configuration

config - method that configure stub server with server params and stubs. It can be a string value (path to configuration JSON file) and a js object.

  • config.server - configuration for node.js server, that will be started.

    • port - port for stub server, default 9000
  • config.stub - array with requests.

Stub configuration:

  • request - request path [required]

  • response - response for this stub, can be a string, JSON, object, path to file [required]

  • file (true/false) - if it's true, and response is path to file, stub server return response file data with correct mime type.

  • strictData (if method is 'get' ignored, default false) - if true stub server select response with most appropriate data

  • data - response data in object format

  • headers (array) - add this headers to response

Contributing

You are welcome :)

If you find bug or want some changes, please, create an issue

v.v.semykin@gmail.com - is my own email. Commits are also from work emails, that can be blocked :)

License

GNU. Fill free to do something good for people

Package Sidebar

Install

npm i stub-server

Weekly Downloads

195

Version

0.1.4

License

ISC

Last publish

Collaborators

  • semykin