Python JSON Schema validation example

README.md

test json schema validation

Setup Virtualenv

$ virtualenv ./venv
$ ./venv/bin/pip install -r requirements.txt

Test/Play:

$ ./venv/bin/python ./v.py

requirements.txt

appdirs==1.4.3
functools32==3.2.3.post2; python_version < '3.0'
jsonschema==2.6.0
packaging==16.8
pycodestyle==2.3.1
pyparsing==2.2.0
simplejson==3.10.0
six==1.10.0

schema-example.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "InventoryItem",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "price": {
      "type": "number",
      "minimum": 0
    },
    "sku": {
      "description": "Stock Keeping Unit",
      "type": "integer"
    }
  },
  "required": ["name", "price"]
}

v.py

import jsonschema
import simplejson as json

with open('schema-example.json', 'r') as f:
    schema_data = f.read()
schema = json.loads(schema_data)

json_obj = {"name": "eggs", "price": 21.47}
jsonschema.validate(json_obj, schema)

json_obj = {"name": "eggs", "price": "blue"}
jsonschema.validate(json_obj, schema)
# jsonschema.exceptions.ValidationError: 'blue' is not of type 'number'
#
# Failed validating 'type' in schema['properties']['price']:
#     {'type': 'number'}
#
# On instance['price']:
#     'blue'

How can we test required?

remove name....
json_obj = {"price": 21.47}
jsonschema.validate(json_obj, schema)