drf-hal-json's Introduction

drf-hal-json

Extension for Django REST Framework 3 which allows for using content-type application/hal-json.

Setup

pip install drf-hal-json

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'drf_hal_json.pagination.HalPageNumberPagination',
    'DEFAULT_PARSER_CLASSES': ('drf_hal_json.parsers.JsonHalParser',),
    'DEFAULT_RENDERER_CLASSES': ('drf_hal_json.renderers.JsonHalRenderer',),

    # To make self links render as 'self' and not 'url', as per the HAL spec
    'URL_FIELD_NAME': 'self',
}

Requirement

Python 2.7+
Django 1.6+
Django REST Framework 3

Features

By using the HalModelSerializer the content is serialized in the HAL JSON format.

Example

Serializer:

class ResourceSerializer(HalModelSerializer):
    class Meta:
        model = Resource

View:

class ResourceViewSet(HalCreateModelMixin, ModelViewSet):
    serializer_class = ResourceSerializer
    queryset = Resource.objects.all()

Request:

GET http://localhost/api/resources/1/ HTTP/1.1
Content-Type  application/hal+json    

{
    "_links": {
        "self": {"href": "http://localhost/api/resources/1/"},
        "relatedResource": {"href": "http://localhost/api/related-resources/1/"}
    },
    "id": 1,
    "_embedded": {
        "subResource": {
            "_links": {
                "self": {"href": "http://localhost/resources/1/sub-resources/26/"},
                "subSubResource": {"href": "http://localhost/resources/1/sub-resources/26/sub-sub-resources/3"}
            },
            "id": 26,
            "name": "Sub Resource 26"
        }
    }
}

Recommend Projects