Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

mock-js-server

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

mock-js-server

Mock server for API

0.0.11
Source
npm

Version published: 5 years ago

Weekly downloads: 23; decreased by-45.24%

Maintainers: 1

Weekly downloads

Created: 6 years ago

Source

mock-js-server

A mock server that allow to generate responses by JSONs or JSs files

Configure it

The first step is to configure config/routes.json, where we will map our API endpoint routes to JSON/JS files.

{
  "^$": "../config/info.json",
  ".*user/{{userId}}.*": "user/default.js"
}

Mock files

There're multiple options to return a response via this server:

JSON file

This wil return JSON response at it's defined in the JSON file.

{
  "status": "OK"
}

Execute JS file

/*globals req, params, query, mock*/
mock = {
  'id': Math.floor(Math.random()*1000),
  'userId': params.userId
}

if (query) {
  if (query.name && query.surname)
    mock.fullname = `${query.name} ${query.surname}`;
}

Mock Object

You must use the @mock key to add contenType or statusCodel ike this:

{
    "@mock": {
        "status": 404,
        "contentType": "text/html",
        "content": "<html><head><title>404</title></head><body>You hit a 404</body></html>"
    }
}

Also you can add a download action to the mock:

{
    "@mock": {
        "status": 200,
        "@download": "./LICENSE"
    }
}

Or add extra headers:

{
    "@mock": {
        "status": 200,
        "headers": [
          "Access-Control-Allow-Origin: *"
        ]
    }
}

Or an option, to delay the response:

{
    "@mock": {
        "status": 200,
        "delay": 1200
    }
}

Run it

Just run npm start to run it simple or configure as tu want with these options:

Option	Key	Default	Description
Config file	`-c`	`config.json`	Name of configuration file
Config Folder	`--config-folder`	`./config/`	Path of configuration's folder
Routes File	`--routes-file`	`routes.json`	Name of the routes file
Mock Folder	`--mocks-folder`	`./mocks/`	Path of the mock folder
Port	`-p`	None	Listening port
Delay	`-d`	None	Delay in ms
Headers	`-H`	None	Extra Headers

Keywords

FAQs

What is mock-js-server?

Is mock-js-server popular?

Is mock-js-server well maintained?

Package last updated on 10 Feb 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install