Skip to content

Latest commit

 

History

History
79 lines (48 loc) · 2.15 KB

README.md

File metadata and controls

79 lines (48 loc) · 2.15 KB
Raw

Build Status

Description

A simple file based HTTP server in node.js. It will serve up content from the filesystem based upon the URL path provided and the content type in 'Accept' header. This is quite useful when creating stubs for testing, or just plain HTTP file serving.

How it works

It's quite simple, like you'd expect an HTTP server like Apache or Nginx to work. The service uses the URL path to work out what directory to look in but it also uses the Accept header to work what the file extension is. If the path is a directory it will serve back the contents, if it's a file then it will serve the file back. If nothing is found a 404 is issued. The logic the server uses is:

  • Check for directory {path}
  • Check for file {path}.{Accept}
  • Check for file {path}

Usage

var server = new HttpServer({port: 8080, baseDir: '.'});
server.start();

Parameters

  • port this is the port the service will bind to
  • baseDir this is the base directory that the service will look into for data files
  • verbose enable verbose mode i.e. logging
  • routes explicitly define possible routes
  • strictRoutes when enabled URL path must match a defined route (or 404 is given)

Examples

List contents of directory cars

GET /cars

Serve the file ./cars/bmw.html

GET /cars/bmw
Accept text/html

or

GET /cars/bmw.html

Create directory ./bikes

PUT /bikes

Create file ./bikes/harley

PUT /bikes/harley
Data { "name": "Harley Davidson" }

Tests

Displaying results in the terminal (common usage):

make test

Running all the tests (calls test-ci and test-cov - best used by CI server):

make test-all

Produce xUnit style XML report file:

make test-ci

Running the tests with coverage and producing HTML Mocha coverage report file:

make test-cov

Prerequisites

You must first install node.js http://nodejs.org

Links