node package manager
Orgs are free. Discover, share, and reuse code in your team. Create a free org »

blueoak-server

BlueOak Logo

BlueOak Server is a NodeJS framework for building RESTful APIs.

Build Status npm version

BlueOak Server is swagger-matic, that is, it maximizes the value of your Swagger API by using it to drive runtime behavior.
BlueOak Server loads your Swagger API, connects the paths it defines to your implementation code, exposes that API to the network, and validates that every request is well-formed per that API.

Check out the documentation on our wiki: https://github.com/BlueOakJS/blueoak-server/wiki

Why'd we do it? (and tell me more about it) - check out the announcement blog.
How can it benefit me and my projects? - check out this experience report.

Overview

BlueOak Server combines some of the best Node libraries into a single tool for building RESTful APIs. It uses Express under the covers, but adds many additional features:

  • Swagger integration
  • Easy configuration
  • Clustering
  • Logging
  • Dependency injection

Projects use the following directory structure.

├── [your_project_name]/
│   ├── index.js <-- optional Main script
│   ├── package.json
|   ├── config/
|   |     └── default.json
│   ├── handlers/
│   ├── services/
│   ├── middleware/
│   ├── swagger/

Handlers

Handlers contain Express route-handling functions. They can either be directly wired to routes on the Express app, or defined using Swagger.

To use the app directly, simply create a js file in the handlers directory that exports an init function. The init function is called during server startup and injected with the the app automatically.

exports.init = function(app) {
  app.get('/', function(req, res) {
    res.json({});
  });
}
 

Services

Services do most of the heavy lifting. Like handlers, services contain init functions that are called during server startup. However, services can export other functions, and those functions can be invoked from handlers.

Here's an example of a fizzbuzz service (services/fizzbuzz.js). You'll notice it has an init method with two parameters, logger and callback. The logger is a built-in service for logging. The callback is an optional parameter used for cases where services need to perform asynchronous operations during startup. The service also exports a getResult function. Any service or handler with a dependency on fizzbuzz can invoke fizzbuzz.getResult.

exports.init = function(logger, callback) {
  logger.info("Starting FizzBuzz service");
  callback();
}
 
exports.getResult = function(num) {
    if (num % 15 === 0) {
        return "FizzBuzz";
    } else if (num % 3 === 0) {
        return "Fizz";
    } else if (num % 5 === 0) {
        return "Buzz";
    } else {
        return num;
    }
};
  

We want to use that service from our handler, so we include fizzbuzz as a parameter of the init function. The server will ensure that the fizzbuzz service is initialized during server startup and passed to the handler.

exports.init = function(app, fizzbuzz) {
 
  app.get('/fizzbuzz/:num', function(req, res) {
    var num = req.params.num;
    res.json({
        result: fizzbuzz.getResult(num)
     });
  });
  
}

Third-party Services

Services can be published as npm modules and pulled into projects through the npm install command.

For example, the bos-couchdb service adds the ability to connect to a CouchDB database. It can be installed to a blueoak-server project using

$ npm install bos-couchdb --save

Once installed, it can be used in any service or handler through the dependency-injected bosCouchdb parameter.

exports.init = function(config, logger, bosCouchdb) {
  var myDb = bosCouchdb.get('mydb');
}
 
  • bos-couchdb - service for connecting to CouchDB databases

Config

Configuration is stored in json files in the config directory. Values can be accessed through the config service in handers and services. Configuration also supports layering on environment-specific config as well as encrypted values.

exports.init = function(config) {
  var myServiceConfig = config.get('myService');
}

Middleware

Middleware are similar to services but used to wire up Express middleware. The express section of the config determines which middleware is loaded and in which order.

{
  "express": {
    "middleware": ["csrf", "cors", "session", "body-parser"]
  }
}

Swagger (OpenAPI)

Swagger files in the swagger directory are read during server startup and automatically wired up to handlers. Swagger files can be in either json or yaml formats.

We've really focused on making API development with Swagger and BlueOak Server to be excellent.
Checkout our ideas on best practices.

At a high-level, BlueOak Server's Swagger support provides the following:

  • Automatic app routing from the API method to the function as defined in the Swagger
  • Request parameter validation, including the body model, based on your method definion
  • Reponse model validation based on your method definitions during development
  • JSON $refs to external Swagger documents on the file system
  • Multiple top-level Swagger API definitions supporting delivery of multiple API base paths
  • Publishing of the fully compiled Swagger spec for input to by tools such as Swagger-UI and swagger-commander

Installation

$ npm install -g blueoak-server

-or-

$ npm install --save blueoak-server

Usage

If installed globally, run blueoak-server from within your project's directory. e.g.:

$ blueoak-server

If installed at a package level, call blueoak-server in the npm start script. e.g.:

  "scripts"{
    "start": "blueoak-server"
  }

Alternatively, it can be launched programmatically from your own js script.

var server = require('blueoak-server');
 
server.init(function(err) {
    if (err) {
        console.warn(err);
    } else {
        console.log('started');
    }
});

The programmatic approach works well during development with tools like nodemon, which monitor for file changes and automatically restart the server.

Next steps

Read through the docs and look at the our examples.

When you're ready to try it out, start from the template.