如何在DRF可浏览API中动态选择Serializer字段？

核心思路 #

基于DRF的CBV（类视图）实现，结合FilterSet提供字段选择界面，同时在视图层动态调整Serializer的展示字段，完全无需修改原有Person模型和PersonSerializer代码，还能保留可浏览API的过滤表单功能。

1. 定义字段选择FilterSet #

先创建FilterSet，提供多选框让用户选择要展示的字段：

from django_filters import rest_framework as filters
from .models import Person

class PersonFilter(filters.FilterSet):
    fields = filters.MultipleChoiceFilter(
        # 生成模型非关联字段的选项列表
        choices=[(field.name, field.verbose_name) for field in Person._meta.get_fields() if not field.is_relation],
        required=False,
        label="选择要展示的字段"
    )

    class Meta:
        model = Person
        fields = []  # 仅保留自定义的字段选择器，无需过滤模型字段

2. 重写CBV的序列化器方法 #

用ListAPIView（或其他GenericAPIView子类），在get_serializer方法中根据用户选择的字段动态调整Serializer的fields：

from rest_framework import generics
from .models import Person
from .serializers import PersonSerializer
from .filters import PersonFilter

class PersonListView(generics.ListAPIView):
    queryset = Person.objects.all()
    serializer_class = PersonSerializer
    filter_backends = (filters.DjangoFilterBackend,)
    filterset_class = PersonFilter

    def get_serializer(self, *args, **kwargs):
        serializer = super().get_serializer(*args, **kwargs)
        # 从请求参数中获取用户选中的字段
        selected_fields = self.request.query_params.getlist('fields')
        
        if selected_fields:
            # 仅保留用户选择且Serializer中存在的字段，避免报错
            valid_fields = [field for field in selected_fields if field in serializer.fields]
            serializer.fields = {field: serializer.fields[field] for field in valid_fields}
        
        return serializer

效果说明 #

• 可浏览API页面会显示「选择要展示的字段」的多选过滤表单，用户选择后提交，返回结果仅包含选中的字段；
• 未选择任何字段时，自动使用原Serializer的默认字段集合，不影响原有功能；
• 全程无需修改原有模型和Serializer代码，完全通过视图层实现动态字段控制。

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