Skip to main content

JSON validator package based on jsonschema that returns nicer validation errors for end users

Project description

CircleCI PyPI version shields.io PyPI license PyPI pyversions

Little Python package that formats validation error messages from jsonschema. You should use this package if you want a stand alone json validator decoupled from any framework.

Reason of being

jsonschema is really cool but its validation error messages suck as they’re meant for developers, not end users. So if you have an API that uses jsonschema to validate json payloads and want to return nicer error messages to your end users you can use this package :)

How it works

3 simple rules:

  • If you don’t send a required property in the payload you’ll get the message All required properties must be present: foo, bar, baz.

  • If validation fails the validation rule will be returned Validation of property 'name' failed: {'minLength': 2, 'type': 'string', 'maxLength': 50}.

  • If you add message property in your validation rule its value will be returned instead of the rule Validation of property 'foo' failed: Custom message will go in here.

Usage

To use, simply do:

from json_payload_validator import validate

schema = {
    'type': 'object',
    'properties': {
        'name': {'type': 'string', 'minLength': 2, 'maxLength': 50},
    },
    'required': [
        'name'
    ]
}

# example of validation
payload = {'name': 'John Maus'}

error = validate(payload, schema)

if error is None:
    print('Validation passed :-)')
else:
    print(error)
    # Validation of property 'name' failed: {'minLength': 2, 'type': 'string', 'maxLength': 50}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

json_payload_validator-0.0.2.tar.gz (2.9 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page