Return errors as json django rest api

Question

Beginner alert. I am using ListCreateAPIView for listing and creating purposes. Whenever I create through an api it returns responses in json format.

{"id":16,"title":"yyyyyyyy","destination_place":[1]}

But if there are errors like duplicate slug or title it returns errors like this

IntegrityError at /api/holidays/
duplicate key value violates unique constraint "holidays_holiday_slug_key"
DETAIL:  Key (slug)=(yyyyyyyy) already exists.

Is there any way to return these errors in json format. My views

class HolidayList(ListCreateAPIView):
    queryset = Holiday.objects.all()
    serializer_class = HolidaySerializer
    permission_classes = [IsAdminUser, IsAuthenticated]

Model

class Holiday(models.Model):
   title = models.CharField(verbose_name=_("Title"), max_length=255)
   slug = models.SlugField(unique=True)
   destination_place = models.ManyToManyField(to='places.Place',related_name='destination_place',null=True,blank=True)

Please post Holiday model.

Sachin
– Sachin

2017-11-13 07:57:58 +00:00
Commented Nov 13, 2017 at 7:57 — Sachin
– Sachin, Commented Nov 13, 2017 at 7:57
Holiday Model added.

Amir Hossain
– Amir Hossain

2017-11-13 08:00:07 +00:00
Commented Nov 13, 2017 at 8:00 — Amir Hossain
– Amir Hossain, Commented Nov 13, 2017 at 8:00

Sachin · Accepted Answer · 2017-11-13 08:14:18Z

1

In HolidaySerializer, add UniqueValidator on slug field.

Example:

from rest_framework.validators import UniqueValidator

class HolidaySerializer(serializers.ModelSerializer):
    slug = serializers.SlugField(
             max_length=255,
             validators=[UniqueValidator(queryset=Holiday.objects.all())])

    class Meta:
        model = Holiday
        fields = ('id', 'title', 'slug', 'destination_place', )

This will return back the unique constraint error in the JSON format.

You can customize the message. Look at the docs.

answered Nov 13, 2017 at 8:14

Sachin

3,6841 gold badge18 silver badges25 bronze badges

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

2 Comments

Amir Hossain Over a year ago

Thanks it works. Is there any way to return json errors for all serializers.

Sachin Over a year ago

If the serializer is not valid, it will return back the error it encountered. If something that you wished the serializer to encounter, then you can override validate method in the serializer.

Collectives™ on Stack Overflow

Return errors as json django rest api

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related