How to fail any Django REST Framework requests with unknown parameters?

Question

Django REST Framework API ignores any unknown parameters. This has led to several issues. For example, when a model filter was missing, a client received all records rather than the single one they were expecting. How can I force DRF to return 400 Bad Request whenever an API call includes an unknown parameter?

(An unknown parameter is one which is not in [SerializerClass].Meta.fields if this is a list, or not in [SerializerClass].Meta.model fields if it is __all__.)

JPG · Accepted Answer · 2018-12-14 01:50:05Z

1

One of the easy and basic solution may be this,

# serializer.py

class FooSerializer(serializers.ModelSerializer):
    class Meta:
        model = Foo
        fields = '__all__'


# views.py
def foo_view(request):
    serializer = FooSerializer(data=request.data)
    if set(request.data.keys()) - set(serializer.fields.keys()):
        raise Exception

Note: Assuming request.data is a dict object

Disclaimer: I'm not sure about the cases while we use source argument in serializer

edited Dec 14, 2018 at 1:50

answered Dec 14, 2018 at 1:44

JPG

89.4k24 gold badges164 silver badges235 bronze badges

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

2 Comments

l0b0 Over a year ago

That looks like an expensive operation for every single API endpoint, but yeah, it should work.

JPG Over a year ago

Yeah, It's expensive. I wouldn't recommend this solution since it's not covered in many cases.

Collectives™ on Stack Overflow

How to fail any Django REST Framework requests with unknown parameters?

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