Hapi MS

Boilerplate for Hapi based micro service.

Install

npm install

Start

npm start

Configuration

Configuration is done through environment variables. For example:

HOST="localhost" PORT="3000" DB_URL="mongodb://localhost/hapi-ms" npm start

See config.js for a full list of supported environment variables and default values.

Presets and utilities

Mongoose

Timestamps

Timestamps are enabled by default on all schemas. To disable them for a specific schema, set the option timestamps to false on it.

Normalized paths

For case-insensitive sorting, properties should be saved in a normalized format. This is done by adding corresponding paths of the to be normalized properties to the normalized sub-document. The values of these fields will be automatically saved in the normalized sub-document in lower case format in the pre-save hook.

Example:

const MySchema = new mongoose.Schema({
  name: {type: String, trim: true, required: true, unique: true},
  normalized: {
    name: String
  }
});

Unique validation

A validator for paths declared as unique is added to all schemas. By default the comparison is case-insensitive, but this can be configured on a schema basis through the option uniqueOptions.

Example:

const MySchema = new mongoose.Schema({
  name: {type: String, unique: true, uniqueOptions: {ci: false}}
});

These validation errors have the type property set to unique.

Properties stripped from replies

By default some properties are stripped out from replies through a custom toJSON that is configured for all schemas. See init/mongoose.js for details.

Joi

MongoId validator

A MongoId validator has been added to Joi. It can be used as follows:

Joi.object({
  id: Joi.string().objectId()
});

Responses

Validation errors

Joi and Mongoose validation errors are transformed to the following format and returned with the HTTP code 400:

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "ValidationError",
  "errors":{
    "path":{
      "type": "<error type>",
      "value": "<path value>"
    },
    "path.subPath":{
      "type": "<error type>",
      "value": "<path value>",
      "<error specific property>": "<property value>"
    }
  }
}

The errors property is an object whose keys are the paths, in dot-notation, of the properties for which validation failed. The values are objects containing:

• type: the error type as returned by the validator (Joi's type and Mongoose's kind properties)
• value: the value of the property
• other error specific properties, e.g. "limit": 5 for Joi validators with a limit value like string.min