https://github.com/paulcwatts/drf-json-schema

Extensible JSON API schema for Django Rest Framework
https://github.com/paulcwatts/drf-json-schema

django djangorestframework json-api python python3

Last synced: about 1 month ago
JSON representation

Extensible JSON API schema for Django Rest Framework

• Host: GitHub
• URL: https://github.com/paulcwatts/drf-json-schema
• Owner: paulcwatts
• License: mit
• Created: 2017-01-27T17:10:57.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-06-02T22:22:55.000Z (over 3 years ago)
• Last Synced: 2024-06-11T16:10:42.880Z (7 months ago)
• Topics: django, djangorestframework, json-api, python, python3
• Language: Python
• Size: 144 KB
• Stars: 15
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
=========================================

JSON API Schema for Django REST Framework

=========================================

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/ambv/black

.. image:: http://www.mypy-lang.org/static/mypy_badge.svg

    :target: http://mypy-lang.org/

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg

    :target: https://github.com/paulcwatts/drf-json-schema/blob/master/LICENSE.txt

An implementation of the `JSON API `_ specification for Django REST Framework,

specifically designed to be extensible and work with code that doesn't use ``ModelSerializer``.

Tested with:

* Python 3.6+

* Django 2.2, 3.11+ 

* Django REST Framework: 3.11+

Development

===========

To begin contributing to the code:

* ``git clone https://github.com/paulcwatts/drf-json-schema.git``

* ``pipenv install --dev``

* ``pipenv run pip install django djangorestframework``

* ``pipenv run pre-commit install``

To run the tests using nox:

* ``pipx install nox``

* ``nox``