micra
it's a small api server.
Install
$ npm install micra
Usage
var micra = ;var config = {};;
config
api
Type: Object
Default: {}
using Express Route paths for the object key
.
the object value
will be returned from server as JSON.
var config = api: '/': type: 'config object' path: '/' { return type: 'config function' path: reqpath params: reqparams ; } ;
src
Type: String
Default: ''
outputting data by .js
, .coffee
and .json
files in the src
directory.
var config = src: '/api';
/api/js.js
moduleexports = type: 'file object' path: '/js'; // output// http://example.com/js// {"type":"file object","path":"/js"}
/api/coffee.coffee
module.exports = type: 'file object' path: '/coffee' # output # http://example.com/coffee # {"type":"file object","path":"/js"}
/api/json.json
// output// http://example.com/json//
/api/function/js.js
module{ return type: 'file function' path: reqpath query: reqquery ;} // output// http://example.com/function/js// {"type":"file function","path":"/function/js","query":{}}//// http://example.com/function/js?key=val// {"type":"file function","path":"/function/js","query":{"key":"val"}}
/api/function/coffee.coffee
= type: 'file function' path: reqpath query: reqquery # output # http://example.com/function/coffee # {"type":"file function","path":"/function/coffee","query":{}} # # http://example.com/function/coffee?key=val # {"type":"file function","path":"/function/coffee","query":{"key":"val"}}
port
Type: Integer
Default: 8888
set any port number.
hostname
Type: String
Default: null
set any host name.
basedir
Type: String
Default: process.cwd()
change base directory of server.
origin
Type: String
or Array
or null
Default: '*'
change Access-Control-Allow-Origin
header.
for example
- null (it allows only same domain with server.)
- '*' (it allows all domains.)
- 'http://example.com'
- 'http://example.com https://example.com http://sub.example.com'
- ['http://example.com', 'https://example.com', 'http://sub.example.com']
default
Type: Object
or null
Default: {}
if the URL path is undefined, the server will return the default data.