Returning pretty JSON error codes from Django REST framework

Question

I need my API to serve explicit error codes for UI applications, that will look similar to i.e. GitHub API:

HTTP/1.1 422 Unprocessable Entity
Content-Length: 149

{
  "message": "Validation Failed",
  "errors": [
    {
      "resource": "Issue",
      "field": "title",
      "code": "missing_field"
    }
  ]
}

What is the best way to implement it in DRF? Is there any package to handle this?

Soufiaane · Accepted Answer · 2016-01-26 16:59:51Z

2

this is how i do it, if it suits your needs:

from rest_framework.response import Response
from rest_framework import status

if serializer.is_valid():
            ..... # Do my logic here
            return Response(serializer.validated_data, status=status.HTTP_201_CREATED)
return Response({
    'status' : 'Bad request',
    'message': 'Account could not be created with received data.',
    'errors' : serializer.errors # for example
}, status=status.HTTP_400_BAD_REQUEST)

edited Jan 26, 2016 at 16:59

answered Jan 26, 2016 at 16:52

Soufiaane

2,1177 gold badges26 silver badges46 bronze badges

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

Collectives™ on Stack Overflow

Returning pretty JSON error codes from Django REST framework

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related