Mock Server that implements the API Blueprint specification.
JavaScript CoffeeScript
Clone or download
Latest commit c4c468d Dec 24, 2017
Permalink
Failed to load latest commit information.
bin
lib
test
.editorconfig add basic api server Jul 9, 2015
.gitignore add feature for output resources. Jul 14, 2015
.jshintrc
.mversionrc
.travis.yml chore(travis): add support version v8.9 Dec 24, 2017
CHANGELOG.md 1.1.7 Dec 24, 2017
LICENSE Initial commit Jul 9, 2015
README.md Add cors option May 11, 2017
gulpfile.coffee chore: add jshint Jul 23, 2015
index.js remove babel in dependency Jul 9, 2015
package.json 1.1.7 Dec 24, 2017

README.md

node-hariko

Mock Server that implements the API Blueprint specification.

npm version Build Status Codacy Badge Code Climate Test Coverage Inline docs Dependency Status

Get started

Installation

npm install -g hariko

Usage

hariko\
  -f <glob expression to your md files>\
  -p <server port>

Examples

for CLI

hariko -f 'docs/**/*.md' -p 8080 -w

for Node.js

var hariko = require('hariko');
hariko.start({
  file: 'docs/**/*.md',
  watch: true
}, function () {
  console.log('Starting hariko server.');
});

CLI Options

file

Filename in the node-glob format of API Blueprint.

hariko -f 'docs/**/*.md'

exclude

Exclude filename in the node-glob format.

hariko -f 'docs/**/*.md'\
       --exclude 'docs/metadata.md'\
       --exclude 'docs/overview.md'

port

Port number of API Server. By default 3000.

hariko -f 'docs/**/*.md' -p 8000

host

Hostname of API Server. By default localhost

hariko -f 'docs/**/*.md' --host '0.0.0.0'

watch

Watching changes for markdown files. By default false.

hariko -f 'docs/**/*.md' -w

This watch we have been using the gaze. If you want to exit the watch is, enter Ctrl + C.

output

Output in the form of HarikoReosurce to JSON.

hariko -f 'docs/**/*.md' -o 'api/'

When output option is enabled, the server can perform realtime data changes because reading JSON.

proxy

A origin for proxy request. By default false.

hariko -f 'docs/**/*.md' --proxy 'http://localhost:8100'

verbose

Output the verbose log. By default false.

hariko -f 'docs/**/*.md' -v

CORS

Send CORS header. By default false.

hariko -f 'docs/**/*.md' --cors

log-level

set to log level.

hariko -f 'docs/**/*.md' --log-level debug

time

Output the logging time. By default false.

hariko -f 'docs/**/*.md' -t

API

var hariko = require('hariko');

hariko.start(options [, startCalleback]);

hariko.start({file: 'docs/**/*.md'}, function () {
  console.log('hariko started!');
});

License

MIT