Validation
Route validation
Validation in the rest-hapi framework is implemented with joi. This includes validation of headers, query parameters, payloads, and responses. joi validation models are based primarily off of each model's field properties. Below is a list of mongoose schema types and their joi equivalent within rest-hapi:
| Schema Type | joi Validation |
|---|---|
| ObjectId | Joi.objectId() (via joi-objectid) |
| Boolean | Joi.bool() |
| Number | Joi.number() |
| Date | Joi.date() |
| String | Joi.string() |
| types | Joi.any() |
Fields of type String can include further validation restrictions based on additional field properties as shown below:
| Field Property | joi Validation |
|---|---|
| enum: [items] | Joi.any().only([items]) |
| regex: RegExp | Joi.string().regex(RegExp) |
| stringType: 'email' | Joi.string().email() |
| stringType: 'uri' | Joi.string().uri() |
| stringType: 'token' | Joi.string().token() |
| stringType: 'base64' | Joi.string().base64() |
| stringType: 'lowercase' | Joi.string().lowercase() |
| stringType: 'uppercase' | Joi.string().uppercase() |
| stringType: 'hostname' | Joi.string().hostname() |
| stringType: 'hex' | Joi.string().hex() |
| stringType: 'trim' | Joi.string().trim() |
| stringType: 'creditCard' | Joi.string().creditCard() |
In addition, if a description: "Description text." field property is included, then .description("Description text.") will be called on the joi validation object.
Furthermore, the regex field can also accept an object that follows the formatting below. See Joi regex options.
{
pattern: RegExp,
options: {
invert: Boolean
}
}
rest-hapi generates joi validation models for create, read, and update events as well as association events with linking models. By default these validation models include all the fields of the mongoose models and list them as optional. However additional field properties can be included to customize the validation models. Below is a list of currently supported field properties and their effect on the validation models.
| Field Property | Validation Model |
|---|---|
| required: true | field required on create |
| requireOnRead: true | field required on read/response |
| requireOnUpdate: true | field required on update |
| allowOnRead: false | field excluded from read model |
| allowOnUpdate: false | field excluded from update model |
| allowOnCreate: false | field excluded from create model |
| queryable: false | field cannot be included as a query parameter |
| exclude: true | field cannot be included in a response or as part of a query |
| allowNull: true | field accepts null as a valid value |
Joi helper methods
rest-hapi exposes the helper methods it uses to generate Joi models through the joiHelper property. Combined with the exposed mongoose wrapper methods, this allows you to easily create custom endpoints. You can see a description of these methods below:
generateJoiReadModel
/**
* Generates a Joi object that validates a query result for a specific model
* @param model: A mongoose model object.
* @param Log: A logging object.
* @returns {*}: A Joi object
*/
generateJoiReadModel = function (model, Log) {...};
generateJoiUpdateModel
/**
* Generates a Joi object that validates a query request payload for updating a document
* @param model: A mongoose model object.
* @param Log: A logging object.
* @returns {*}: A Joi object
*/
generateJoiUpdateModel = function (model, Log) {...};
generateJoiCreateModel
/**
* Generates a Joi object that validates a request payload for creating a document
* @param model: A mongoose model object.
* @param Log: A logging object.
* @returns {*}: A Joi object
*/
generateJoiCreateModel = function (model, Log) {...};
generateJoiListQueryModel
/**
* Generates a Joi object that validates a request query for the list function
* @param model: A mongoose model object.
* @param Log: A logging object.
* @returns {*}: A Joi object
*/
generateJoiListQueryModel = function (model, Log) {...};
generateJoiFindQueryModel
/**
* Generates a Joi object that validates a request query for the find function
* @param model: A mongoose model object.
* @param Log: A logging object.
* @returns {*}: A Joi object
*/
generateJoiFindQueryModel = function (model, Log) {...};
generateJoiFieldModel
/**
* Generates a Joi object for a model field
* @param model: A mongoose model object
* @param field: A model field
* @param fieldName: The name of the field
* @param modelType: The type of CRUD model being generated
* @param Log: A logging object
* @returns {*}: A Joi object
*/
generateJoiFieldModel = function (model, field, fieldName, modelType, Log) {...};
generateJoiModelFromFieldType
/**
* Returns a Joi object based on the mongoose field type.
* @param field: A field from a mongoose model.
* @param Log: A logging object.
* @returns {*}: A Joi object.
*/
generateJoiModelFromFieldType = function (field, Log) {...};
joiObjectId
/**
* Provides easy access to the Joi ObjectId type.
* @returns {*|{type}}
*/
joiObjectId = function () {...};
isValidField
/**
* Checks to see if a field is a valid model property
* @param fieldName: The name of the field
* @param field: The field being checked
* @param model: A mongoose model object
* @returns {boolean}
*/
isValidField = function (fieldName, field, model) {...};