Django REST Exceptions

by

The Django REST framework provides several built in exceptions, which are mostly subclasses of DRF’s APIException.

You can raise exceptions in your view like you normally would in Python:

from rest_framework.exceptions import APIException

def my_view(request):
    raise APIException("There was a problem!")

You could also create your own custom exception by inheriting from APIException and setting status_code and default_detail. Some of the built in ones are: ParseError, AuthenticationFailed, NotAuthenticated, PermissionDenied, NotFound, NotAcceptable, ValidationError, etc.

These will then get converted to a Response by the REST Framework’s exception handler. Each exception is associated with a status code that is added to the Response. By default the exception handler is set to the built in handler:

REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler'
}

But you can set it to your own custom exception handler if you want to convert the exceptions yourself by changing this in your settings.py file:

REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'my_project.my_app.utils.custom_exception_handler'
}

And then create the custom handler in that location:

from rest_framework.views import exception_handler

def custom_exception_handler(exc, context):
    # Call REST framework's default exception handler first,
    # to get the standard error response.
    response = exception_handler(exc, context)

    # Now add the HTTP status code to the response.
    if response is not None:
        response.data['status_code'] = response.status_code

    return response

Related Contents:

  1. Django REST Framework: adding additional field to ModelSerializer
  2. Django REST framework: non-model serializer
  3. What are the differences between django-tastypie and djangorestframework? [closed]
  4. Token Authentication for RESTful API: should the token be periodically changed?
  5. Django Rest Framework: Disable field update after object is created
  6. Django testing rest-framework: APIRequestFactory vs APIClient
  7. Django Rest Framework make OnetoOne relation ship feel like it is one model
  8. How to get Request.User in Django-Rest-Framework serializer?
  9. Django Rest Framework remove csrf
  10. Django Rest Framework: Dynamically return subset of fields
  11. Django Rest Framework with ChoiceField
  12. Django rest framework nested self-referential objects
  13. RuntimeError: Model class django.contrib.sites.models.Site doesn’t declare an explicit app_label and isn’t in an application in INSTALLED_APPS
  14. Pass extra arguments to Serializer Class in Django Rest Framework
  15. Pass request context to serializer from Viewset in Django Rest Framework
  16. How do I create multiple model instances with Django Rest Framework?
  17. “Post Image data using POSTMAN”
  18. Django REST Framework – Separate permissions per methods
  19. How to set current user to user field in Django Rest Framework?
  20. Authorization Credentials Stripped — django, elastic beanstalk, oauth
  21. How do I create a login API using Django Rest Framework?
  22. Django Rest framework, how to include ‘__all__’ fields and a related field in ModelSerializer ?
  23. Django Rest Framework, passing parameters with GET request, classed based views
  24. generics vs viewset in django rest framework, how to prefer which one to use?
  25. SocketException: OS Error: Connection refused, errno = 111 in flutter using django backend
  26. Additional field while serializing django rest framework
  27. How to make a PATCH request using DJANGO REST framework
  28. Django – Where are the params stored on a PUT/DELETE request?
  29. How can I test binary file uploading with django-rest-framework’s test client?
  30. Serializing a list of objects with django-rest-framework
  31. Exclude a field from django rest framework serializer
  32. How can I apply a filter to a nested resource in Django REST framework?
  33. Django REST Framework viewset per-action permissions
  34. Django and Restful APIs
  35. context in nested serializers django rest framework
  36. Django rest framework – filtering for serializer field
  37. 405 POST method not allowed
  38. Is APITest with Query params different then just normal url?
  39. Django Rest-Framework nested serializer order
  40. Django REST Framework POST nested objects
  41. django rest framework – how do you flatten nested data?
  42. Django: Rest Framework authenticate header
  43. How can I make a trailing slash optional on a Django Rest Framework SimpleRouter
  44. Circular dependency in Django Rest Framework serializers
  45. django-rest-framework: api versioning
  46. Per Field Permission in Django REST Framework
  47. django-rest-framework http put failing with 415 on django 1.5
  48. django rest framework: set field-level error from serializer validate() method
  49. Django REST Framework pagination links do not use HTTPS
  50. How do you return 404 when resource is not found in Django REST Framework

Leave a Comment