Django Rest Framework自定义序列化器：多模型组合自定义数据结构API端点实现方案咨询

针对你想要在Django REST Framework（DRF）中构建自定义序列化结构API的需求，我整理了几个实用的实现思路，你可以根据项目复杂度和灵活性需求来选择：

1. 嵌套序列化器+视图层组装元数据 #

这是最常用的方式，利用DRF的嵌套序列化器处理关联模型的数据，再在视图层添加请求相关的元数据。

步骤1：定义嵌套序列化器 #

先从最底层的Event开始，逐层向上定义包含嵌套关系的序列化器，同时可以通过SerializerMethodField添加自定义字段（比如event_count）：

from rest_framework import serializers
from .models import Season, Evening, Event

class EventSerializer(serializers.ModelSerializer):
    class Meta:
        model = Event
        fields = ["id", "name", ...]  # 指定你需要返回的事件字段

class EveningSerializer(serializers.ModelSerializer):
    events = EventSerializer(many=True, read_only=True)
    event_count = serializers.SerializerMethodField()

    # 自定义计算事件数量
    def get_event_count(self, obj):
        return obj.event_set.count()

    class Meta:
        model = Evening
        fields = ["evening_id", "day", "date", "event_count", "events"]

class SeasonSerializer(serializers.ModelSerializer):
    evenings = EveningSerializer(many=True, read_only=True)

    class Meta:
        model = Season
        fields = ["season", "evenings"]

步骤2：在视图中构造完整响应 #

在视图里获取目标季节的数据，序列化后和请求元数据组合成最终结构：

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.status import HTTP_404_NOT_FOUND
from .models import Season
from .serializers import SeasonSerializer
from datetime import datetime

class CombinedDataAPI(APIView):
    def get(self, request):
        # 可以通过请求参数动态指定季节，比如request.query_params.get("season")
        try:
            # 预加载关联数据，避免N+1查询问题
            season = Season.objects.prefetch_related("evenings__events").get(season="2021/2022")
        except Season.DoesNotExist:
            return Response({"error": "Season not found"}, status=HTTP_404_NOT_FOUND)
        
        season_serialized = SeasonSerializer(season).data
        
        # 组装包含元数据的最终响应
        final_response = {
            "requestTime": datetime.now().strftime("%Y-%m-%d %H:%M"),
            "requestURL": request.path,
            "requestMethod": request.method,
            "responseCode": 200,
            **season_serialized
        }
        
        return Response(final_response)

2. 完全自定义序列化逻辑（适合复杂结构） #

如果你的响应结构和模型关联差异很大，可以直接在视图中手动构造数据结构，不需要依赖嵌套序列化器：

class CustomCombinedDataAPI(APIView):
    def get(self, request):
        season = Season.objects.prefetch_related("evenings__events").get(season="2021/2022")
        
        # 手动构建每个层级的数据
        evenings_data = []
        for evening in season.evenings.all():
            events_data = [
                {"id": event.id, "name": event.name, ...} 
                for event in evening.event_set.all()
            ]
            evenings_data.append({
                "evening_id": evening.id,
                "day": evening.day,
                "date": evening.date.strftime("%Y-%m-%d"),
                "event_count": len(events_data),
                "events": events_data
            })
        
        final_response = {
            "requestTime": datetime.now().strftime("%Y-%m-%d %H:%M"),
            "requestURL": request.path,
            "requestMethod": request.method,
            "responseCode": 200,
            "season": season.season,
            "evenings": evenings_data
        }
        
        return Response(final_response)

3. 重写ViewSet的响应方法（适合用ViewSet的场景） #

如果你的项目用了DRF的ViewSet，可以重写list或retrieve方法来修改响应结构：

from rest_framework import viewsets

class SeasonViewSet(viewsets.ReadOnlyModelViewSet):
    queryset = Season.objects.prefetch_related("evenings__events")
    serializer_class = SeasonSerializer

    def retrieve(self, request, *args, **kwargs):
        instance = self.get_object()
        serializer = self.get_serializer(instance)
        
        # 包装序列化后的数据
        custom_response = {
            "requestTime": datetime.now().strftime("%Y-%m-%d %H:%M"),
            "requestURL": request.path,
            "requestMethod": request.method,
            "responseCode": 200,
            **serializer.data
        }
        
        return Response(custom_response)

关键优化点 #

• 数据库查询优化：一定要用prefetch_related("evenings__events")来预加载关联数据，避免多次查询数据库导致性能问题。
• 动态参数支持：可以通过URL路径参数或查询参数传递季节标识，让接口更通用。
• 错误处理：记得添加异常捕获，比如季节不存在时返回404响应，提升接口的健壮性。

内容的提问来源于stack exchange，提问作者grisuu