/ 
Swagger2-0.78
River stage zero No dependents
/ Swagger2::SchemaValidator

NAME

Swagger2::SchemaValidator - Sub class of JSON::Validator

DESCRIPTION

This class is used to validate Swagger specification. It is a sub class of JSON::Validator and adds some extra functionality specific for Swagger2.

ATTRIBUTES

Swagger2::SchemaValidator inherits all attributes from JSON::Validator.

formats

Swagger support the same formats as Swagger2::SchemaValidator, but adds the following to the set:

  • byte

    A padded, base64-encoded string of bytes, encoded with a URL and filename safe alphabet. Defined by RFC4648.

  • date

    An RFC3339 date in the format YYYY-MM-DD

  • double

    Cannot test double values with higher precision then what the "number" type already provides.

  • float

    Will always be true if the input is a number, meaning there is no difference between "float" and "double". Patches are welcome.

  • int32

    A signed 32 bit integer.

  • int64

    A signed 64 bit integer. Note: This check is only available if Perl is compiled to use 64 bit integers.

METHODS

Swagger2::SchemaValidator inherits all attributes from JSON::Validator.

validate_input

This method will make sure "readOnly" is taken into account, when validating data sent to your API.

validate_request

@errors = $self->validate_request($c, $schema, \%input);

Takes an Mojolicious::Controller and a schema definition and returns a list of errors, if any. Validated input parameters are moved into the %input hash.

This method is EXPERIMENTAL.

validate_response

@errors = $self->validate_response($c, $schema, $status, $data);

This method is EXPERIMENTAL.

COPYRIGHT AND LICENSE

Copyright (C) 2014-2015, Jan Henning Thorsen

This program is free software, you can redistribute it and/or modify it under the terms of the Artistic License version 2.0.

AUTHOR

Jan Henning Thorsen - jhthorsen@cpan.org