django-rest-framework: api versioning

by

UPDATE:

versioning is now properly supported.

There are some answers from your link:

We found it practical and useful to put the version in the URL. It
makes it easy to tell what you’re using at a glance. We do alias /foo
to /foo/(latest versions) for ease of use, shorter / cleaner URLs,
etc, as the accepted answer suggests.
Keeping backwards compatibility forever is often cost-prohibitive and/or very difficult. We prefer to give advanced notice of
deprecation, redirects like suggested here, docs, and other
mechanisms.

So we took this approach, plus allowing clients to specify the version in request header (X-Version), here is how we did it:

Structure in side the API app:

.
├── __init__.py
├── middlewares.py
├── urls.py
├── v1
│   ├── __init__.py
│   ├── account
│   │   ├── __init__.py
│   │   ├── serializers.py
│   │   └── views.py
│   └── urls.py
└── v2
    ├── __init__.py
    ├── account
    │   ├── __init__.py
    │   ├── serializers.py
    │   └── views.py
    └── urls.py

project urls.py:

url(r'^api/', include('project.api.urls', namespace="api")),

api app level urls.py:

from django.conf.urls import *

urlpatterns = patterns('',
    url(r'', include('project.api.v2.urls', namespace="default")),
    url(r'^v1/', include('project.api.v1.urls', namespace="v1")),
)

version level urls.py

from django.conf.urls import *
from .account import views as account_views
from rest_framework.routers import DefaultRouter

router = DefaultRouter()
router.register('account', account_views.AccountView)
router.register('myaccount', account_views.MyAccountView)
urlpatterns = router.urls

create a middleware to switch to the correct code by changing the path_info, please note there is a caveat that namespace (‘api’) defined in project level urls is not flexible and needs to be known in middleware:

from django.core.urlresolvers import resolve
from django.core.urlresolvers import reverse


class VersionSwitch(object):

    def process_request(self, request):
        r = resolve(request.path_info)
        version = request.META.get('HTTP_X_VERSION', False)
        if r.namespace.startswith('api:') and version:
            old_version = r.namespace.split(':')[-1]
            request.path_info = reverse('{}:{}'.format(r.namespace.replace(old_version, version), r.url_name), args=r.args, kwargs=r.kwargs)

Sample url:

curl -H "X-Version: v1" http://your.domain:8000/api/myaccount/

Related Contents:

  1. Pass extra arguments to Serializer Class in Django Rest Framework
  2. Django REST Framework – Separate permissions per methods
  3. Return the current user with Django Rest Framework
  4. How do I create a login API using Django Rest Framework?
  5. Django REST Framework serializer field required=false
  6. How to PATCH a single field using Django Rest Framework?
  7. Django Rest-Framework nested serializer order
  8. Django REST Framework POST nested objects
  9. Django-Rest-Framework. Updating nested object
  10. How do I include related model fields using Django Rest Framework?
  11. Disable a method in a ViewSet, django-rest-framework
  12. django.db.migrations.exceptions.InconsistentMigrationHistory
  13. Django Rest Framework – Could not resolve URL for hyperlinked relationship using view name “user-detail”
  14. Django Rest Framework – Authentication credentials were not provided
  15. Django Rest Framework File Upload
  16. When to use Serializer’s create() and ModelViewset’s perform_create()
  17. Retrieving a Foreign Key value with django-rest-framework serializers
  18. Django rest framework serializing many to many field
  19. Python Django Rest Framework UnorderedObjectListWarning
  20. Django Rest Framework – How to add custom field in ModelSerializer
  21. Django or Django Rest Framework
  22. Django Rest Framework partial update
  23. Django Rest Framework Token Authentication
  24. What is the benefit of using a HyperlinkedModelSerializer in DRF?
  25. Django Rest Framework: turn on pagination on a ViewSet (like ModelViewSet pagination)
  26. django-rest-framework 3.0 create or update in nested serializer
  27. Do CSRF attacks apply to API’s?
  28. OperationalError, no such column. Django
  29. How to return custom JSON in Django REST Framework
  30. Django REST Framework upload image: “The submitted data was not a file”
  31. How can I register a single view (not a viewset) on my router?
  32. Proper way to consume data from RESTFUL API in django
  33. How can I use Django OAuth Toolkit with Python Social Auth?
  34. Django Rest Framework – APIView Pagination
  35. Editing django-rest-framework serializer object before save
  36. Django Rest Framework – Get related model field in serializer
  37. How to add custom field in ModelSerializer?
  38. Django Rest Framework writable nested serializers
  39. how to reverse the URL of a ViewSet’s custom action in django restframework
  40. Why does Django Rest Framework discourage model level validation?
  41. Django Python rest framework, No ‘Access-Control-Allow-Origin’ header is present on the requested resource in chrome, works in firefox
  42. How to update user password in Django Rest Framework?
  43. how to add annotate data in django-rest-framework queryset responses?
  44. Adding REST to Django [closed]
  45. Django and Middleware which uses request.user is always Anonymous
  46. Serialize queryset in Django rest framework
  47. Django Serializer Method Field
  48. Django REST Framework – Serializing optional fields
  49. Django viewset has not attribute ‘get_extra_actions’
  50. How to use Query Strings for filtering Querysets in Django?

Leave a Comment