mittwald/psr7-validation

PSR-7 middleware for JSON schema validation

Maintainers

Details

github.com/mittwald/php-psr7-validation

Source

Issues

Installs: 17 507

Dependents: 0

Suggesters: 1

Security: 0

Stars: 4

Watchers: 6

Forks: 2

Open Issues: 0

v1.1.0 2018-04-16 07:53 UTC

Requires

Requires (Dev)

MIT f201458d1c6f75a924ea1d09b86d1aa6376c8abb

  • Martin Helmich <m.helmich.woop@mittwald.de>
  • Baris Gürgöl <b.guergoel.woop@mittwald.de>

This package is auto-updated.

Last update: 2024-12-13 00:21:54 UTC

README

Build Status

Synposis

This package contains a PSR-7 middleware for validating HTTP requests, especially using JSON schema validation.

Warning: This package is still under development; its API can change at any time without notice. Use at own risk.

License

This package is MIT-licensed.

Examples

Validating request bodies using a JSON schema (using the Slim framework):

$app->post('/customers', $handler)
    ->add(new ValidationMiddleware(
        Factory::buildJsonValidatorFromUri('path/to/json-schema.json')
    ));

Validating request bodies using a Swagger specification file:

$app->post('/customers', $handler)
    ->add(new ValidationMiddleware(
        Factory::buildJsonValidatorFromSwaggerDefinition('path/to/swagger.json', 'MyType')
    ));

Validating request bodies using a custom validator (using PHP 7's anonymous classes, for no other reason because I can):

$app->post('/customers', $handler)
    ->add(new ValidationMiddleware(
        new class implements ValidatorInterface {
            public function validateJson($jsonDocument, ValidationResult $result) {
                $result->addErrorForProperty('customernumber', 'Foo');
            }
        }
    ));

Combining multiple validators:

$app->post('/customers', $handler)
    ->add(new ValidationMiddleware(
        new CombinedValidator(
            Factory::buildJsonValidatorFromUri('path/to/schema.json'),
            new MyVerySpecialCustomValidator()
        )
    ));