Skip to main content

JSON Schema support for Django REST Framework

Project description

Version:
3.0.0
Source:

https://github.com/maykinmedia/drf-jsonschema-serializer

Keywords:

django, rest, jsonschema

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.

See the documentation for getting started and usage examples.

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.

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

drf_jsonschema_serializer-3.0.0.tar.gz (14.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file drf_jsonschema_serializer-3.0.0.tar.gz.

File metadata

File hashes

Hashes for drf_jsonschema_serializer-3.0.0.tar.gz
Algorithm Hash digest
SHA256 8a42c6079225f789cd55321897073b576d15db3406d008e92f44febb017a232a
MD5 79c2182fde4ccb817010107029fdd1cd
BLAKE2b-256 c607bb376e2af6f600351fd5f70e93939fcb09869c520a0a79dc415c652d3d58

See more details on using hashes here.

File details

Details for the file drf_jsonschema_serializer-3.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for drf_jsonschema_serializer-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d0e5cce095a5638b0bb7867aa060ed59ab9eed2f54ba5058dd9b483c9c887ed5
MD5 022ab150bd1a0917e9555c83909c3272
BLAKE2b-256 2f711f500097efe09e04c3be862ab26c997314237a8b0a16dc3e3047fee23f4c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page