NAME

Conch::Plugin::JsonValidator

SYNOPSIS

app->plugin('Conch::Plugin::JsonValidator');

[ ... in a controller ]

sub endpoint ($c) {
    my $body = $c->validate_input('MyInputDefinition');
    ...
}

DESCRIPTION

Conch::Plugin::JsonValidator provides an optional manner to validate input and output from a Mojo controller against a JSON Schema.

The validate_input helper uses the provided schema definition to validate JUST the incoming JSON request. Headers and query parameters ARE NOT validated. If the data fails validation, a 400 status is returned to user with an error payload containing the validation errors.

SCHEMAS

validate_input validates data against the json-schema/input.yaml file.

HELPERS

validate_input

Given a json schema name validate the provided input against it, and prepare a HTTP 400 response if validation failed; returns validated input on success.

get_input_validator

Returns a JSON::Validator object suitable for validating an endpoint input.

get_response_validator

Returns a JSON::Validator object suitable for validating an endpoint response.

LICENSING

Copyright Joyent, Inc.

This Source Code Form is subject to the terms of the Mozilla Public License, v.2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.