com.networknt.validator

Class SchemaValidator

java.lang.Object

com.networknt.validator.SchemaValidator

public class SchemaValidator
extends Object

Validate a value against the schema defined in a Swagger/OpenAPI specification.

Supports validation of properties and request/response bodies, and supports schema references.

Author:

Steve Hu

Constructor Summary

Constructors

Constructor and Description
SchemaValidator() Build a new validator with no API specification.
SchemaValidator(io.swagger.models.Swagger api) Build a new validator for the given API specification.

Method Summary

Modifier and Type	Method and Description
com.networknt.status.Status	validate(Object value, io.swagger.models.Model schema) Validate the given value against the given model schema.
com.networknt.status.Status	validate(Object value, io.swagger.models.properties.Property schema) Validate the given value against the given property schema.
com.networknt.status.Status	validate(String value, io.swagger.models.Model schema) Validate the given value against the given model schema.
com.networknt.status.Status	validate(String value, io.swagger.models.properties.Property schema) Validate the given value against the given property schema.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SchemaValidator

public SchemaValidator()

Build a new validator with no API specification.

This will not perform any validation of $ref references that reference local definitions.

SchemaValidator

public SchemaValidator(io.swagger.models.Swagger api)

Build a new validator for the given API specification.

Parameters:

api - The API to build the validator for. If provided, is used to retrieve schema definitions for use in references.

Method Detail

validate

public com.networknt.status.Status validate(Object value,
                                            io.swagger.models.properties.Property schema)

Validate the given value against the given property schema.

Parameters:

value - The value to validate

schema - The property schema to validate the value against

Returns:

A status containing error code and description

validate

public com.networknt.status.Status validate(Object value,
                                            io.swagger.models.Model schema)

Validate the given value against the given model schema.

Parameters:

value - The value to validate

schema - The model schema to validate the value against

Returns:

A status containing error code and description

validate

public com.networknt.status.Status validate(String value,
                                            io.swagger.models.properties.Property schema)

Validate the given value against the given property schema.

Parameters:

value - The value to validate

schema - The property schema to validate the value against

Returns:

A status containing error code and description

validate

public com.networknt.status.Status validate(String value,
                                            io.swagger.models.Model schema)

Validate the given value against the given model schema.

Parameters:

value - The value to validate

schema - The model schema to validate the value against

Returns:

A status containing error code and description