node-red-contrib-request-validator 1.0.0

a node-red custom node to create schemas to validate incoming requests data.

npm install node-red-contrib-request-validator

node-red-contrib-request-validator

A Node-RED custom node, to create schema for validate request fields

Requirements

• node-red version >=1.3.7

Installation

Install via Node-RED Manage Palette

node-red-contrib-request-validator

Install via npm

$ cd ~/.node-red
$ npm install node-red-contrib-request-validator
# then restart node-red

Usage

Create Schemas to validate request method, body and query parameters. Schemas are configured in this node Properties.

Properties

• Method (GET, POST, PUT, DELETE) - the expected method of the request to be validated.

• Query Params (json) - the Schema of the expected query params.

• Body Params (json) - the Schema of the expected body params.

Outputs

1. Valid Request (top output)
   • msg (any) - the original msg of request.
2. Invalid Request (bottom output)
   • payload (json) - the error message.
   • statusCode (400 | 500) - the status code of error.

Schema

Schema Params

• type (string | number | boolean | array | date | any) - the type of the param.
• required (true | false) - whether the param is required or not.
• subtype (string | number | boolean | date | any) - if the type is array, the subtype of the array elements.
• specifications (json) - the specifications of the param.

Specifications

a specifications is a json object, used to validate specifics aspects of the param. Has the following properties:

• min (number) - the minimum value of the param. If the param is an String, the min length of the param.
• max (number) - the maximum value of the param. If the param is an String, the max length - the param.
• float (true | false) - whether the param is a float number
• format ( "email" | "phone" | "date" | "cnpj" | "cpf" ) - the format of the string param.

Examples

Body schema example

    {
        "name": {
            "type": "string",
            "required": true
        },
        "phoneList": {
            "type": "array",
            "subtype": "string"
        }
    }

Verification steps

1. Verify that the request body exist.
2. Verify if exist property name and its type is string.
3. If exist property addressList verify if its type is array and its subtype is string.
4. If all the validations are passed, send the original msg to the node connected to the top output.
5. If any validation fails, send the error message to the node connected to the bottom output.

Query specific schema example

    {
        "id": {
            "type": "number",
            "required": true,
            "specifications":{
                "min": 1,
                "float": false,
            }
        }
    }

Verification steps

1. Verify that the request query exist.
2. Verify if exist property id.
3. Verify if the query string can be converted to a number.
4. Verify if a id is Integer number.
5. Verify if a id is greater or equal than 1.