A lightweight mixin to allow routing Django Rest Framework endpoints to different classes depending on version.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
djangorestversioning
.gitignore
LICENSE.md
MANIFEST.in
README.md
setup.cfg
setup.py

README.md

Simple versioning for Django REST framework

pypi-version

Overview

Django Rest Framework provides the ability to version an API via multiple methods, namespacing the URL, adding a version to the Accept header or query parameter, and provides this version to your code. However, it doesn't go further than this in helping split up what code is ran based on this version, leaving this a task up to the developer.

This mixin allows the developer to set which class is ran depending on what version is passed to the API, without interferring with how DRF generic views work.

Requirements

  • Python 2.7+
  • Django Rest Framework 3.1+

Installation

Install using pip...

pip install djangorestversioning

Example

Make sure you're using a versioning class in your settings.py (Rest Framework does not default to any versioning class)

REST_FRAMEWORK = {
	'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.AcceptHeaderVersioning'
}

Ensure you're using namespacing on your endpoints

urlpatterns = patterns(
    '',
    url(r'^api/', include(patterns(
        '',
        url(r'^items/', include('items.urls')),
    ), namespace='1.0')),
)

You wire up your generic view URL's in the same way as before:

from django.conf.urls import url
from items.views import ItemList

# Wire up your API using generic views
urlpatterns = [
    url(r'^items/$', ItemList.as_view())
]

Ensure the resulting generic view has the versioning mixin, and that you provide a versions dictionary detailing where each version of the endpoint exists.

from djangorestversioning.versioning import VersionedEndpoint

class ItemList(VersionedEndpoint, APIView):
	"""
	List all items.
	"""
	versions = {
		1.0 : 'api.v1.items.ItemList',
		2.0 : 'api.v2.items.ItemList'
	}

Each version of the endpoint can now do what it needs to do per version

# v1
class ItemList(ListAPIView):
	"""
	List all items for v1.
	"""
    serializer_class = ItemSerializer
	queryset = Item.objects.all()
# v2
class ItemList(ListCreateAPIView):
	"""
	List all items for v2, enable creation on v2
	"""
    serializer_class = ItemSerializer
	queryset = Item.objects.all()

Considerations

If you request a version which does not have a corresponding entry in the versions dictionary, the dispatcher will select the latest version available by running max on the keys of the versions. This requires that keys in the dictionary are numerical, and ordered. This could be improved upon in the future.

If a module or class is not found, an ImportError or AttributeError will be raised.