@pmu-tech/stub-server
Stub/mock server for REST APIs
For each route, decide what will happen: a JSON stub, a piece of JS or redirect to a real server
- Use it with Express, webpack-dev-server or the command line
- Support stubs written in JSON, JS, TypeScript, HTML, jpg...
- Can redirect requests to another host thx to node-http-proxy
- No need to restart stub-server if you modify a stub
- The HTTP status code returned is determined from the stub filename: *_200_*.json, *_500_*.html...
- Configurable delays to simulate slow APIs
Usage
npm install --save-dev @pmu-tech/stub-server
Proposed file organization
stubs/routes/my_api1_GET_200_OK.json
my_api2_GET_200_OK.jpg
my_api3_POST_400_BadRequest-invalidField.ts
my_api4_POST_400_BadRequest-invalidField.js
my_api5_DELETE_500_InternalServerError.html
my_api7_GET_200_OK.json
my_api7_POST_200_OK.json
my_api8_GET.ts
my_api9_GET.js
my_api10_GET_200_OK-param1.json
my_api10_GET_200_OK-param2.json
stubs/config.ts
webpack.config.ts
stubs/config.ts
import { resolve } from 'path';
import { StubServerConfig } from '@pmu-tech/stub-server';
const prod = 'https://pmu.fr';
const stubsPath = resolve(__dirname, 'routes');
const config: StubServerConfig = {
delay: { min: 500, max: 3000 },
routes: {
'/my/api1': { GET: `${stubsPath}/my_api1_GET_200_OK.json` },
'/my/api2': { GET: `${stubsPath}/my_api2_GET_200_OK.jpg` },
'/my/api3': { POST: `${stubsPath}/my_api3_POST_400_BadRequest-invalidField.ts` },
'/my/api4': { POST: `${stubsPath}/my_api4_POST_400_BadRequest-invalidField.js` },
'/my/api5': { DELETE: `${stubsPath}/my_api5_DELETE_500_InternalServerError.html` },
'/my/api6/:id': { PUT: prod },
'/my/api7': {
delay: { min: 1000, max: 1000 },
GET: `${stubsPath}/my_api7_GET_200_OK.json`,
POST: {
delay: { min: 0, max: 0 },
response: `${stubsPath}/my_api7_POST_200_OK.json`
}
},
'/my/api8': { GET: `${stubsPath}/my_api8_GET.ts`},
'/my/api9': { GET: `${stubsPath}/my_api9_GET.js`},
'/my/api10/:id': { GET: req => `${stubsPath}/my_api10_GET_200_OK-${req.params.id}.json` }
}
};
const rootApiPath = 'https://pmu.fr/client/:clientApi';
config.routes[`${rootApiPath}/my/api7`] = { GET: `${stubsPath}/my_api7_GET_200_OK.json` };
export default config; // Or "exports.default = config"webpack.config.ts
Configuration with webpack-dev-server
import { stubServer } from '@pmu-tech/stub-server';
// ...
devServer: {
// ...
before: app => {
const configPath = path.resolve(__dirname, 'stubs', 'config');
stubServer(configPath, app);
}
// ...
},
// ...stubs/routes/my_api1_GET_200_OK.json
{
"foo": "bar"
}stubs/routes/my_api3_POST_400_BadRequest-invalidField.ts
export default {
error: 'Invalid field'
};stubs/routes/my_api4_POST_400_BadRequest-invalidField.js
module.exports = {
error: 'Invalid field'
};stubs/routes/my_api8_GET.ts
import express from 'express';
export default function stub(req: express.Request, res: express.Response) {
res.send('Hello, World!');
}stubs/routes/my_api9_GET.js
module.exports = (req, res) => {
res.send('Hello, World!');
};Command line
Usage: stub-server [options]
Options:
-p, --port <port> stub server port (default: "12345")
-c, --config <config> config file (default: "stubs/config")
-h, --help display help for command
Next.js
// server.js
const { resolve } = require('path');
const express = require('express');
const next = require('next');
const Log = require('next/dist/build/output/log');
const { stubServer } = require('@pmu-tech/stub-server');
const port = 3000;
const configPath = resolve(__dirname, 'stubs', 'config');
const dev = process.env.NODE_ENV !== 'production';
const app = next({ dev });
const handle = app.getRequestHandler();
app.prepare().then(() => {
const server = express();
stubServer(configPath, server);
server.all('*', (req, res) => handle(req, res));
server.listen(port, () => {
// https://github.com/zeit/next.js/blob/v9.3.1/packages/next/build/output/store.ts#L85-L88
Log.ready(`ready on port ${port}`);
});
});// package.json
{
"scripts": {
"dev": "node server.js", // Instead of "next dev"
"build": "next build",
"start": "next start"
}
}Contributing
Prerequisites
- Node.js >= 10
- VSCode extensions: "EditorConfig for VS Code" and "Prettier - Code formatter"
Build
npm run build
