Skip to content
Mock Server that implements the API Blueprint specification.
JavaScript TypeScript API Blueprint Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
bin
docker-dev
lib
src
test
.editorconfig
.eslintrc.js
.gitignore
.jshintignore
.jshintrc
.mversionrc
.prettierrc
.travis.yml
CHANGELOG.md
LICENSE
README.md
index.js
package-lock.json
package.json
tsconfig.json

README.md

node-hariko

Mock Server that implements the API Blueprint specification.

npm version Build Status Code Climate Test Coverage

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!')
})

Development

run build

> ./docker-dev/bin/build
> docker run --rm -it -v$(pwd):/usr/local/docker/app --name hariko hariko npm run build

run tests

> ./docker-dev/bin/build
> docker run --rm -it --name hariko hariko npm test

License

MIT

You can’t perform that action at this time.