Package Exports
- servemocks
- servemocks/src/public-api.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (servemocks) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
servemocks
| Contributing | Changelog | Powered by diva-e |
|---|
Starts a webserver which provides a REST API derived from JSON, XML and other sample files located in a specified directory.
Consider the following directory structure:
mock-api/
├── image
│ └── logo.png
├── v1
│ ├── user
│ │ ├── 1.json
│ │ ├── 2.json
| | └── [any].json
│ ├── user.json
│ └── user.post.json
└── v2
├── health.json
└── sitemap.xmlServing directory mock-api with servemocks would create a webserver with the folllowing http endpoints:
- GET /image/logo.png
- GET /v1/user
- POST /v1/user
- GET /v1/user/1
- GET /v1/user/2
- GET /v2/health
- GET /v2/sitemap
Check the examples directory for more information about api conventions.
Starting from version 2 it is also possible to produce dynamic mock responses by using an ecmascript module
as mock file. Use the file extension .mjs to enable this function.
Example: examples/v3.
Getting Started
Install
# install as global package
npm install -g servemocks
# or project-local
npm add -D servemocksUsage
servemocks <directory> [-p, --port=8080] [-c, --compact-logging]Example:
servemocks examples/mock-api -p 5000Programmatic Usage
Servemocks is based on express and can be mounted as a submodule inside an existing app.
import { createServeMocksExpressApp } from 'servemocks';
const mainApp = express();
const options = {
responseDelay_ms: 100,
// servemocks prints every endpoint it registers to the console
// this might bloat the console log and thus you can change this setting here
endpointRegistrationLogging: 'compact', // default is 'verbose', use 'disabled' to not show any of those logs
// enable javascript code to be executed from a mock file with
// .mjs file extension
// eval can be used as alternative strategy if dynamicImport does not work
dynamicMockResponsesMode: 'eval' // one of 'disabled', 'eval' and 'dynamicImport'
}
mainApp.use('/mock-api', createServeMocksExpressApp('examples/mock-api', options))