serve-api v0.0.9

serve-api

Serve middleware for mocking api

Usage

// express
var express = require('express')
var serveApi = require('serve-api')

var app = express()

app.use(serveApi('dir/to/api'))
app.listen(3000)

// dong-queue
var Queue = require('dong-queue')
var serveApi = require('serve-api')

var queue = new Queue()

queue.use(serveApi('dir/to/api'))

http.createServer(function onRequest(req, res){
  queue.run(req, res, function() {
    // finalhandler
  })
})

Mocking

Searching for js and json files in the directory

Pattern

{
  "<URL>": {
    "<METHOD>": "<VALUE>"
  }
}

• <URL>: Request URL, without query string.
• <METHOD>: RESTful request method，such as POST|PATCH|PUT|DELETE|GET, and * matches all methods.
• <VALUE>: Response text, could be json or string.

Examples

module.exports = {
  '/foo/bar': {
    'GET': function(url, query) {
      // do something with url and query
      return {
        code: 0,
        message: 'ok'
      };
    }
  }
};

module.exports = {
  '/foo/bar': {
    '*': {
      code: 0,
      message: 'ok'
    }
  }
};

{
  "/foo/bar": {
    "*": {
      "code": 0,
      "message": "ok"
    }
  }
}

// for redirect, etc
{
  "/foo/bar": {
    "*": {
     "MOCKAPI": {
       "redirect": "some.url",
       // or change status
       "status": 201,
       "response": {}
     }
    }
  }
}