how to exclude fields that are in one depth level with DRF?

user_14632651 0
Viewed 973

how to exclude fields that are in one depth level in django rest framework?
I want to remove id field in testPieces and resultTestsList.

this is my API:

enter image description here

my serializer:

class Test_Serializer(serializers.ModelSerializer):
    class Meta:
        model = Test_1
        exclude = ["id"]
        depth = 3

my models:

class Test_pieces_1_question(models.Model):
    question = models.CharField(max_length=3000)
    yesScore = models.IntegerField()
    noScore = models.IntegerField()
    
class Result_tests_list_1(models.Model):
    text = models.CharField(max_length=3000)
    score = models.IntegerField()
    unicode = models.CharField(max_length=500)

class Test_1(models.Model):    
    name = models.TextField(max_length=3000)
    category = models.CharField(max_length=500)
    time = models.CharField(max_length=500)
    testPieces = models.ManyToManyField(Test_pieces_1_question)
    resultTestsList = models.ManyToManyField(Result_tests_list_1)

my view:

class Whole_test(mixins.ListModelMixin, generics.GenericAPIView):
    queryset = Test_1.objects.all()
    serializer_class = Test_Serializer
    filter_backends = [DjangoFilterBackend]

    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

thanks!

django-rest-framework django
1 Answers

The best way to do this is to use custom nested serializers. And expose the fields that you really want to expose to the frontend app. It is called the zero-trust approach. I personally prefer it over the exclude approach.

Let's rewrite your serializer in a way to achieve the same result as depth =3

class Test_Serializer(serializers.ModelSerializer):
    testPieces = TimePiecesSerializer(many=True, read_only=True)
    resultTestsList = TimeResultSerializer(many=True, read_only=True)
    class Meta:
        model = Test_1
        fields = ["name", "category", "time", "testPieces", "resultTestsList"]

As you see I have added to nested serializer instead of depth=3

So here is the code for those custom serializers

class TimePiecesSerializer(serializers.ModelSerializer):
    class Meta:
        model = Test_pieces_1_question
        fields = ["question", "yesScore", "noScore"]


class TimeResultSerializer(serializers.ModelSerializer):

    class Meta:
        model = Result_tests_list_1
        fields = ["text", "score", "unicode"]

Using the above nesting serializer approach will give you the same results as depth and will also exclude the key id as it seems you are not interested in it.

You may need a little tunning according to your fields but it is a more promising approach over others.

user_109121220
Related