Readme for Request-Guardian

request-guardian is a middleware function that validates incoming requests against a set of validation rules using express-validator. It can be used to ensure that data sent to a server is in the expected format and meets certain criteria. If the validation fails, it returns a 400 error response with an array of validation errors.

Installation

To install request-guardian, use npm or yarn.

1npm install request-guardian

1yarn add request-guardian

Usage

request-guardian is a middleware function that can be used with Express applications. To use it, simply require the module and use it as middleware for your routes.

NOTE: Make sure that you call the validate() method after a middleware to parse incoming requests with JSON payloads.

1const express = require('express');
2const validate = require('request-guardian');
3
4const app = express();
5
6// middleware to parse incoming requests with JSON payloads.
7app.use(express.json());
8
9// Use Request Guardian middleware
10validate(app);
11
12// define your routes
13app.post('/users', (req, res) => {
14    // handle validated request
15});

Validation rules are defined in separate files located in the utils/validations/index.js directory. request-guardian will look for a file with the same name as the current route and load any validation rules defined within that file.

1// utils/validations/index.js
2
3const { body } = require('express-validator');
4
5module.exports = {
6    '/api/authentication/signup': [
7        body('email').isEmail(),
8        body('password').isLength({ min: 8 }),
9    ]
10} ;

If no validation rules are found for the current route, request-guardian will simply pass the request to the next middleware function in the stack.