Json Schema validation

[fesor]

Json Schema is very powerful tool to verify JSON responses. But it not so user friendly and very verbose. Custom schema definitions and refs makes life a little bit easier but not so much.

I like the way type declarations made in RAML 1.0. It has a lot of sugar, it allows users to define user types, extending primitives. So we need to implement something like this:

// register custom type
JsonMatcher\Types::register('email', [
    'pattern' => '^.+\@\S+\.\S+'
]);

// or register multiple types:
JsonMatcher\Types::register([
    'integer' => [
         'type' => 'number',
         'multipleOf' => 1.0
    ],
    'positiveInteger' => [
         'type' => 'integer',
         'minimum' => 0,
         'exclusiveMinimum' => true
    ],
    'UserRegisterRequest' => [
         'properties' => [
              'email' => 'email',
              'password' => [
                   'minLength' => 4
              ],
              'first_name?' => 'string',
              'last_name?' => 'string'
         ]
    ],
]);

And then we can just use it:

$json->matches('UserRegisterRequest');
// or we can use inline type declarations
$json->matches([
    'type' => 'UserRegisterRequest',
    'properties' => [
        'foo' => 'string'
    ]
]);

Type expressions

Type expressions are fully stolen from RAML:

Type expressions provide a powerful way of referring to, and even defining, types. Type expressions can be used wherever a type is expected. The simplest type expression is just the name of a type. Using type expressions, you can devise type unions, arrays, maps, and other things.

Expression	Description
Person	The simplest type expression: A single type
Person[]	An array of Person objects
string[]	An array of string scalars
string[][]	A bi-dimensional array of string scalars
`string	Person`
`(string	Person)[]`