swagger-enforcer

v1.3.13

Published

2 years ago

Automatically validate a value against the swagger schema while you build it. Alternatively you can validate the final value.

Downloads

518

0High
0Medium
0Low

gi60s

swagger response build compose validate

THIS PROJECT HAS BEEN DEPRECATED IN FAVOR OF OPENAPI-ENFORCER AND OPENAPI-ENFORCER-MIDDLEWARE THAT PROVIDE BETTER TOOLS, CUSTOMIZABILITY, AND SUPPORTS THE OPEN API SPECIFICATION VERSIONS 2 AND 3.

Swagger-Enforcer

Automatically validate a value against the swagger schema while you build it. Alternatively you can validate the final value.

To validate while building (enforce), this package requires support of the native Proxy interface. For NodeJS that means version 6.0.0 and newer. If your node version is lower than that you can still validate the final value (validate) but will be unable to enforce while building.

Examples

Example 1

Validate While Building (enforce)

const Enforcer = require('swagger-enforcer');

// a schema to enforce
const schema = {
    type: 'object',
    properties: {
        num: {
            type: 'number',
            minimum: 0
        },
        str: {
            type: 'string',
            enum: ['foo', 'bar', 'baz'],
            default: 'foo'
        }
    }
};

// define swagger schema definitions
const definitions = {};

// define enforcer options
const options = { useDefaults: true };

// create enforcer instance that defines which rules to enforce
const enforcer = Enforcer(schema, definitions, options);

// build an object that enforces the schema
const obj = enforcer.enforce();

console.log(obj);       // { str: 'foo' } - this is because 'str' had a default value: 
obj.num = 5;            // validates successfully and value is set
obj.str = 'abc';        // throws an error because 'abc' is not in enum

Example 2

Validate the Final Value (validate)

const Enforcer = require('swagger-enforcer');

// a schema to enforce
const schema = {
    type: 'object',
    properties: {
        num: {
            type: 'number',
            minimum: 0
        },
        str: {
            type: 'string',
            enum: ['foo', 'bar', 'baz'],
            default: 'foo'
        }
    }
};

// create enforcer instance that defines which rules to enforce
const enforcer = Enforcer(schema, {}, { useDefaults: true });

// build the object
const obj = {
    num: 5,
    str: 'abc'
};

// validate the object
enforcer.validate(schema, obj);  // throws an error because 'abc' is not in enum

API

Enforcer (Constructor)
- Enforcer.prototype.enforce - Create an object with enforcement.
- Enforcer.prototype.errors - Run a full validation of an value and get back an array of Error objects.
- Enforcer.prototype.validate - Run a full validation of an value.
Enforcer.applyTemplate - Create an unenforced object with templates and defaults applied.
- defaults
Enforcer.injectParameters - Replace string parameters.
- defaults - Set injectParameter defaults
Enforcer.is - Type checking.
Enforcer.release - Create an unenforced copy of an enforced object.
Enforcer.same - Check if two values are equivalent.
Enforcer.to - Type conversion.

Enforcer

Produce an enforcer instance that can enforce a swagger schema while you build the object and/or that validates the object after it is built.

Signature: Enforcer (schema [, definitions [, options ] ]) : Enforcer

Parameters:

schema - The swagger schema to use for enforcement of values.

definitions - An object containing definitions by name. Definitions are only necessary if using discriminators.

{
    Pet: {
        type: 'object',
        discriminator: 'petType',
        properties: {
            name: {
                type: 'string'
            },
            petType: {
                type: 'string'
            }
        },
        required: ['name', 'petType']
    },
    Cat: {
        type: 'object',
        allOf: [
            {
                $ref: '#/definitions/Pet'
            },
            {
                type: 'object',
                properties: {
                    name: {
                        type: 'string'
                    },
                    petType: {
                        type: 'string'
                    },
                    huntingSkill: {
                        type: string
                    }
                }                
            }
        ]
    }
}

options - Enforcement options. Defaults to:

{
    autoFormat: false,
    enforce: {
        enum: true,
        maxItems: true,
        minItems: false,
        uniqueItems: true,
        multipleOf: true,
        maximum: true,
        minimum: true,
        maxLength: true,
        minLength: true,
        pattern: true,
        additionalProperties: true,
        maxProperties: true,
        minProperties: false,
        required: false
    },
    useDefaults: false
}

Returns - An enforcer instance with the following prototype methods: Enforcer.prototype.enforce and Enforcer.prototype.validate.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Swagger-Enforcer

Contents

Examples

Example 1

Example 2

API

Enforcer

Enforcer.prototype.enforce

Enforcer.prototype.errors

Enforcer.prototype.validate

Enforcer.applyTemplate

Enforcer.applyTemplate.defaults

Enforcer.injectParameters

Enforcer.injectParameters.defaults

Enforcer.is

Enforcer.is.binary

Enforcer.is.boolean

Enforcer.is.byte

Enforcer.is.date

Enforcer.is.dateTime

Enforcer.is.integer

Enforcer.is.number

Enforcer.release

Enforcer.same

Enforcer.to

Enforcer.to.binary

Enforcer.to.boolean

Enforcer.to.byte

Enforcer.to.date

Enforcer.to.dateTime

Enforcer.to.integer

Enforcer.to.number

Enforcement Options