JSON API support for Django REST Framework
- Documentation: https://django-rest-framework-json-api.readthedocs.org/
- Format specification: http://jsonapi.org/format/
By default, Django REST Framework will produce a response like:
{
"count": 20,
"next": "http://example.com/api/1.0/identities/?page=3",
"previous": "http://example.com/api/1.0/identities/?page=1",
"results": [{
"id": 3,
"username": "john",
"full_name": "John Coltrane"
}]
}
However, for an identity model in JSON API format the response should look
like the following:
{
"links": {
"prev": "http://example.com/api/1.0/identities",
"self": "http://example.com/api/1.0/identities?page=2",
"next": "http://example.com/api/1.0/identities?page=3",
},
"data": [{
"type": "identities",
"id": 3,
"attributes": {
"username": "john",
"full-name": "John Coltrane"
}
}],
"meta": {
"pagination": {
"count": 20
}
}
}
As a Django REST Framework JSON API (short DJA) we are trying to address following goals:
Support the JSON API spec to compliance
Be as compatible with Django REST Framework as possible
e.g. issues in Django REST Framework should be fixed upstream and not worked around in DJA
Have sane defaults to be as easy to pick up as possible
Be solid and tested with good coverage
Be performant
- Python (2.7, 3.4, 3.5, 3.6, 3.7)
- Django (1.11, 2.0, 2.1)
- Django REST Framework (3.6, 3.7, 3.8, 3.9)
$ pip install djangorestframework-jsonapi
$ git clone https://github.com/django-json-api/django-rest-framework-json-api.git $ cd django-rest-framework-json-api $ pip install -e .
It is recommended to create a virtualenv for testing. Assuming it is already installed and activated:
$ git clone https://github.com/django-json-api/django-rest-framework-json-api.git $ cd django-rest-framework-json-api $ pip install -r example/requirements.txt $ pip install -e . $ django-admin migrate --settings=example.settings $ django-admin loaddata drf_example --settings=example.settings $ django-admin runserver --settings=example.settings
Browse to http://localhost:8000
It is recommended to create a virtualenv for testing. Assuming it is already installed and activated:
$ pip install -r requirements-development.txt $ flake8 $ pytest
rest_framework_json_api assumes you are using class-based views in Django
Rest Framework.
One can either add rest_framework_json_api.parsers.JSONParser and
rest_framework_json_api.renderers.JSONRenderer to each ViewSet class, or
override settings.REST_FRAMEWORK
REST_FRAMEWORK = {
'PAGE_SIZE': 10,
'EXCEPTION_HANDLER': 'rest_framework_json_api.exceptions.exception_handler',
'DEFAULT_PAGINATION_CLASS':
'rest_framework_json_api.pagination.JsonApiPageNumberPagination',
'DEFAULT_PARSER_CLASSES': (
'rest_framework_json_api.parsers.JSONParser',
'rest_framework.parsers.FormParser',
'rest_framework.parsers.MultiPartParser'
),
'DEFAULT_RENDERER_CLASSES': (
'rest_framework_json_api.renderers.JSONRenderer',
'rest_framework.renderers.BrowsableAPIRenderer',
),
'DEFAULT_METADATA_CLASS': 'rest_framework_json_api.metadata.JSONAPIMetadata',
'DEFAULT_FILTER_BACKENDS': (
'rest_framework_json_api.filters.QueryParameterValidationFilter',
'rest_framework_json_api.filters.OrderingFilter',
'rest_framework_json_api.django_filters.DjangoFilterBackend',
'rest_framework.filters.SearchFilter',
),
'SEARCH_PARAM': 'filter[search]',
'TEST_REQUEST_RENDERER_CLASSES': (
'rest_framework_json_api.renderers.JSONRenderer',
),
'TEST_REQUEST_DEFAULT_FORMAT': 'vnd.api+json'
}
This package provides much more including automatic inflection of JSON keys, extra top level data (using nested serializers), relationships, links, paginators, filters, and handy shortcuts. Read more at http://django-rest-framework-json-api.readthedocs.org/