Skip to main content

JSON Schema support for Django REST Framework

Project description

Version:
2.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-2.0.0.tar.gz (12.3 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file drf-jsonschema-serializer-2.0.0.tar.gz.

File metadata

File hashes

Hashes for drf-jsonschema-serializer-2.0.0.tar.gz
Algorithm Hash digest
SHA256 bfeea9f2e49f6f14d12ae5a55680657abb70066615739682351589cda67c3f4f
MD5 8ff0c3596fa4e357f0c65ef2ef0330fc
BLAKE2b-256 11776b058c860c965fa991ad88c7009c27b2d8dcb27d2d72330a865541535734

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for drf_jsonschema_serializer-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 02b4e4f19d680b0565a4231f1cba29371c01af0e1682944f1e2d1093bbd07d86
MD5 27b70539abecfe107be7b9e2ee78defd
BLAKE2b-256 dec9284efcbd9af4dfc6f222ddffcb93fa0dfa5e94186fde9b226ef22ffc2491

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