Django Rest 框架 - 一个用于 API 和 drf-spectacular 的 serailizer

Question

I have a serializer for DRF, and drf-spectacular. My serializer works that i expect but in GUI don't present currectly. So i need to have tho diffrents serializer one for schema and second for endpoint. But i wanna use one, how to fix this?

My serializer:

class GetConversionCasesSerializer(serializers.Serializer):
    conversionId = serializers.SerializerMethodField()
    cases = serializers.SerializerMethodField()

    def get_cases(self, obj):
        serializer = ResultDataSerializer(ResultData.objects.filter(conversion=obj), many=True)
        data = serializer.data
        return data

    def get_conversionId(self, obj):
        return obj.id

Schema serializer:

class GetConversionCasesSerializerSchema(serializers.Serializer):
    conversionId = serializers.IntegerField()
    cases = serializers.ListSerializer(child=ResultDataSerializer())

Api endpoint:

    @extend_schema(request=None, responses=GetConversionCasesSerializerSchema())
def get(self, *args, **kwargs):
    if self.request.version == "v1":
        conversion_id = self.kwargs.get('conversion_id')
        instance = Conversion.objects.get(id=conversion_id)
        serializer = GetConversionCasesSerializer(instance)
        return Response(serializer.data)
    else:
        return Response(status=status.HTTP_400_BAD_REQUEST)

When i use to show schema normal selialiser i have:

in schema serializer:

How to fix first serializer and have one for schema and get method?

Answer 1

Since your models are related, you could just nest serializers . Here's a simple example:

from rest_framework import serializers

from app.models import Conversion, ResultData


class ResultDataSerializer(serializers.ModelSerializer):
    # TODO: Define only the attributes you're interested
    class Meta:
        model = ResultData
        fields = '__all__' 


class GetConversionCasesSerializer(serializers.ModelSerializer):
    conversionId = serializers.CharField(source='id')
    cases = ResultDataSerializer(many=True, source='resultdata_set')  # `source` depends on your case

    class Meta:
        model = Conversion
        fields = ('id', 'resultdata_set',)  # add other fields of interest

Note that I used ModelSerializer everywhere as it already implements some logic for creating resources (not interesting in your use case if it's only returning data to the caller) and automatically maps model fields to DRF fields.