Installation

npm install connect-api-mocker --save-dev

Usage

Using withConnect

varhttp=require('http');varconnect=require('connect');varapiMocker=require('connect-api-mocker');varapp=connect();app.use('/api',apiMocker('mocks/api'));http.createServer(app).listen(8080);

Using withExpress

varexpress=require('express');varapiMocker=require('connect-api-mocker');varapp=express();app.use('/api',apiMocker('mocks/api'));app.listen(8080);

Using withBrowserSync

varbrowserSync=require('browser-sync').create();varapiMocker=require('connect-api-mocker');varrestMock=apiMocker('/api','mocks/api');browserSync.init({server:{baseDir:'./',middleware:[restMock,],},port:8080,});

Using withlite-server

varapiMocker=require('connect-api-mocker');varrestMock=apiMocker('/api','mocks/api');module.exports={server:{middleware:{// Start from key `10` in order to NOT overwrite the default 2 middleware provided// by `lite-server` or any future ones that might be added.10:restMock,},},port:8080,};

Using with Grunt

module.exports=function(grunt){varapiMocker=require('connect-api-mocker');grunt.loadNpmTasks('grunt-contrib-connect');// Connect - Development server// Project configuration.grunt.initConfig({// Development serverconnect:{server:{options:{base:'./build',port:9001,middleware:function(connect,options){varmiddlewares=[];// mock/rest directory will be mapped to your fake REST APImiddlewares.push(apiMocker('/api','mocks/api'));// Static filesmiddlewares.push(connect.static(options.base));middlewares.push(connect.static(__dirname));returnmiddlewares;}}}}});}

Using with Webpack

  ...before:function(app){app.use(apiMocker('/api','mocks/api'));},  ...

Using with CRA

npm install customize-cra react-app-rewired --save-dev

constapiMocker=require("connect-api-mocker"),{ overrideDevServer}=require("customize-cra");constdevServerConfig=()=>config=>{return{        ...config,before:(app,server)=>{//call cra before function to not break codeconfig.before(app,server);//Then add our mocker url and folderapp.use(apiMocker('/api','mocks/api'));}}}module.exports={devServer:overrideDevServer(devServerConfig())};

..."scripts":{"start":"react-app-rewired start",    ...}  ...

Using with other languages other than JavaScript

Directory Structure

_ api  \_ messages     \_ GET.json

_ api  \_ messages     \_ 1        \_ GET.json

_ api  \_ messages     \_ 1        \_ POST.json

_ api  \_ messages     \_ 1        \_ DELETE.json

Custom responses

_ api  \_ messages     \_ POST.js

module.exports=function(request,response){if(!request.get('X-Auth-Key')){response.status(403).send({});}else{response.sendFile('POST.json',{root:__dirname});}}

constfs=require('fs');constpath=require('path');module.exports=(request,response)=>{if(!request.get('X-Auth-Key')){response.statusCode=403;response.end();}else{constfilePath=path.join(__dirname,'POST.json');conststat=fs.statSync(filePath);response.writeHead(200,{'Content-Type':'application/json','Content-Length':stat.size});constreadStream=fs.createReadStream(filePath);// We replaced all the event handlers with a simple call to readStream.pipe()readStream.pipe(response);}}

Another Example: Respond different json files based on a query parameter:

constfs=require('fs');constpath=require('path');module.exports=function(request,response){lettargetFileName='GET.json';// Check is a type parameter existif(request.query.type){// Generate a new targetfilename with that type parametertargetFileName='GET_'+request.query.type+'.json';}constfilePath=path.join(__dirname,targetFileName);// If file does not exist then respond with 404 headertry{fs.accessSync(filePath);}catch(err){returnresponse.status(404);}// Respond with filePathresponse.sendFile(filePath);}

consturl=require('url');constfs=require('fs');constpath=require('path');module.exports=function(request,response){lettargetFileName='GET.json';consttypeQueryParam=url.parse(request.url,true).query.type;// Check is a type parameter existif(typeQueryParam){// Generate a new targetfilename with that type parametertargetFileName='GET_'+typeQueryParam+'.json';}varfilePath=path.join(__dirname,targetFileName);// If file does not exist then respond with 404 headertry{fs.accessSync(filePath);}catch(err){response.statusCode=404;response.end();return;}conststat=fs.statSync(filePath);response.writeHead(200,{'Content-Type':'application/json','Content-Length':stat.size});constreadStream=fs.createReadStream(filePath);// We replaced all the event handlers with a simple call to readStream.pipe()readStream.pipe(response);}

Helper functions for custom responses

const{ notFound}=require('connect-api-mocker/helpers');module.exports=notFound('Page is not found');

const{ delay, created, json}=require('connect-api-mocker/helpers');module.exports=[delay(500),created(),json({success:true})];

const{ json}=require('connect-api-mocker/helpers');module.exports=[json(req=>({id:req.params.userId,success:true}))];

const{ type, file}=require('connect-api-mocker/helpers');// Assuming a file named GET.png exists next to this fileconstfilePath=path.join(__dirname,'./GET.png');module.exports=[type('image/png'),file(filePath)];

Wildcards in requests

module.exports=function(request,response){response.json({id:request.params.user_id});}

module.exports=function(request,response){response.json({id:request.params.user_id,method:request.method});}

XML Support

app.use('/user-api',apiMocker({target:'other/target/path',type:'xml'}));

app.use('/user-api',apiMocker({target:'other/target/path',type:'auto'}));

Defining multiple mock configurations

app.use('/api/v1',apiMocker('target/path'));app.use('/user-api',apiMocker({target:'other/target/path'}));app.use(apiMocker('/mobile/api',{target:'mocks/mobile'});

Next on not found option

apiMocker('/api',{target:'mocks/api',nextOnNotFound:true});

Body parser

apiMocker('/text',{target:'test/mocks',bodyParser:false})

apiMocker('/text',{target:'test/mocks',bodyParser:{type:'text',options:{type:'application/vnd.custom-type'}}})

Logging

apiMocker('/api',{target:'mocks/api',verbose:({ req, filePath, fileType})=>console.log(`Mocking endpoint${req.originalUrl} using${filePath}.${fileType}.`)});