dataclasses-jsonschema 1.0.0

JSON schema generation from dataclasses

JSON schema generation from python 3.7 dataclasses. Python 3.6 is supported through the dataclasses backport. Also provides serialisation to and from JSON data with JSON schema validation.

Examples

from dataclasses import dataclass

from dataclasses_jsonschema import JsonSchemaMixin


@dataclass
class Point(JsonSchemaMixin):
    x: float
    y: float

Generate the schema:

>>> pprint(Point.json_schema())
{
    'description': 'Point(x:float, y:float)',
    'type': 'object',
    'properties': {
        'x': {'format': 'float', 'type': 'number'},
        'y': {'format': 'float', 'type': 'number'}
    },
    'required': ['x', 'y']
}

Deserialise data:

>>> Point.from_dict({'x': 3.14, 'y': 1.5})
Point(x=3.14, y=1.5)
>>> Point.from_dict({'x': 3.14, y: 'wrong'})
jsonschema.exceptions.ValidationError: 'wrong' is not of type 'number'

TODO

• Support type Union using ‘oneOf’

• Support NewType fields