Django REST Framework JSON Schema

Tests and PyPI publishing Coverage status Linting and code quality black Documentation Status

python-versions django-versions pypi-version

JSON Schema support for Django REST Framework

Overview

drf-jsonschema-serializer is a library built around Django REST Framework. It does the following:

  • Convert a DRF serializer into a JSON Schema.

  • Provides JSONSchemaField that can validate JSON data according to a JSON schema.

  • Provides a SerializerJSONField that can validate JSON data according to a serializer for a field.

This lets you use client-side form libraries such as react-jsonschema-form to generate a web form from a serializer. This way you can use the same schema for client-side form generation and validation as you use for REST service input validation.

Credits and roadmap

Many thanks to https://github.com/isprojects for the initial work on this library. As of September 2021, Maykin Media has taken up maintenance of this package after transferring it from isprojects. See the issues on Github for the roadmap.

See also CREDITS.txt for a full history of authorship.

Contents:

Indices and tables