Django REST Custom Errors

Question

I’m trying to create a custom error response from the REST Django framework.

I’ve included the following in my views.py,

from rest_framework.views import exception_handler

def custom_exception_handler(exc):
    """
    Custom exception handler for Django Rest Framework that adds
    the `status_code` to the response and renames the `detail` key to `error`.
    """
    response = exception_handler(exc)

    if response is not None:
        response.data['status_code'] = response.status_code
        response.data['error'] = response.data['detail']
        response.data['detail'] = "CUSTOM ERROR"

    return response

And also added the following to settings.py.

REST_FRAMEWORK = {
              'DEFAULT_PERMISSION_CLASSES': (
                  'rest_framework.permissions.AllowAny',
              ),
              'EXCEPTION_HANDLER': 'project.input.utils.custom_exception_handler'
        }

Am I missing something as I don’t get the expected response. i.e a custom error message in the 400 API response.

Thanks,

argaen · Accepted Answer · 2014-03-31 16:46:28Z

11

As Bibhas said, with custom exception handlers, you only can return own defined errors when an exception is called. If you want to return a custom response error without exceptions being triggered, you need to return it in the view itself. For example:

    return Response({'detail' : "Invalid arguments", 'args' : ['arg1', 'arg2']}, 
                     status = status.HTTP_400_BAD_REQUEST)

answered Mar 31, 2014 at 16:46

argaen

4,30526 silver badges28 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

felix001 Over a year ago

sure, but will this provide me with a custom error via a JSON response. As Ive tried this but Im getting "global name 'Response' is not defined".

argaen Over a year ago

You need to import the rest_framework Response: from rest_framework.response import Response. And yes, this code will return a JSON response with the structure you specify ({'detail' : "Invalid arguments", 'args' : ['arg1', 'arg2']} in this case) and the error code you need (400, check restframework status codes for more)

Bibhas Debnath · Accepted Answer · 2014-03-31 16:41:55Z

0

From the documentation -

Note that the exception handler will only be called for responses generated by raised exceptions. It will not be used for any responses returned directly by the view, such as the HTTP_400_BAD_REQUEST responses that are returned by the generic views when serializer validation fails.

answered Mar 31, 2014 at 16:41

Bibhas Debnath

15k18 gold badges70 silver badges96 bronze badges

Collectives™ on Stack Overflow

Django REST Custom Errors

2 Answers 2

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related