Django REST Framework 如何实现列表接口仅返回指定字段、详情返回全量字段
实现方案
方案1:按视图action切换对应序列化器(无冗余逻辑,易维护)
你当前使用的ReadOnlyModelViewSet本身天然区分两个访问入口:
listaction 对应/api/character列表接口retrieveaction 对应/api/character/<主键>详情接口
直接复用你现有的全量字段序列化器负责详情逻辑,新增一个仅返回要求字段的精简序列化器负责列表逻辑,不需要改动原有全量序列化器的嵌套关联定义:
- 在
serializer.py中新增列表专用序列化器
class CharacterListSerializer(serializers.ModelSerializer): class Meta: model = Character fields = ['id', 'name']
- 在
views.py中重写get_serializer_class方法,根据当前action自动匹配对应序列化器
class CharacterViewSet(viewsets.ReadOnlyModelViewSet): permission_classes = [] queryset = Character.objects.all() filter_backends = [filters.SearchFilter, DjangoFilterBackend] search_fields = ['name'] filterset_fields = ['language', 'region', 'realm', 'faction', 'race', 'wow_class', 'spec', 'covenant', 'soulbind'] def get_serializer_class(self): # 列表接口返回精简字段,其余接口沿用全量字段配置 if self.action == 'list': return CharacterListSerializer return CharacterSerializer
方案2:单序列化器动态裁剪返回字段(无冗余类定义)
如果不想新增独立的列表序列化器类,可以直接改造现有CharacterSerializer,让它支持初始化时动态指定需要返回的字段,避免重复定义嵌套关联的序列化逻辑:
- 修改
serializer.py中的现有CharacterSerializer,新增动态字段裁剪逻辑,原有的嵌套关联、全量字段定义全部保留不动
class CharacterSerializer(serializers.ModelSerializer): # 原有嵌套关联序列化器全部保留,不做改动 language = LanguageSerializer(read_only=True) region = RegionSerializer(read_only=True) realm = RealmSerializer(read_only=True) faction = FactionSerializer(read_only=True) race = RaceSerializer(read_only=True) wow_class = ClassSerializer(read_only=True) spec = SpecSerializer(read_only=True) talents = TalentSerializer(many=True, read_only=True) pvp_talents = PvpTalentSerializer(many=True, read_only=True) covenant = CovenantSerializer(read_only=True) soulbind = SoulbindSerializer(read_only=True) conduits = ConduitSerializer(many=True, read_only=True) def __init__(self, *args, **kwargs): # 提取外部传入的字段裁剪参数,动态删除不需要的返回字段 target_fields = kwargs.pop('fields', None) super().__init__(*args, **kwargs) if target_fields: for field_name in list(self.fields.keys()): if field_name not in target_fields: self.fields.pop(field_name) class Meta: model = Character # 原有全量字段列表全部保留,不做改动 fields = ['id', 'name', 'language', 'region', 'realm', 'faction', 'race', 'wow_class', 'spec', 'talents', 'pvp_talents', 'covenant', 'covenant_rank', 'soulbind', 'soulbind_abilities', 'conduits', 'item_level', 'media', 'avatar', 'rating_2v2', 'rating_3v3', 'rating_rbg', 'max_2v2', 'max_3v3', 'max_rbg', 'achievement_points', 'account_achievements', 'seasons', 'alters', 'date_added', 'last_search', 'checked']
- 修改
views.py中的CharacterViewSet,在初始化序列化器时根据action传入裁剪规则
class CharacterViewSet(viewsets.ReadOnlyModelViewSet): serializer_class = CharacterSerializer permission_classes = [] queryset = Character.objects.all() filter_backends = [filters.SearchFilter, DjangoFilterBackend] search_fields = ['name'] filterset_fields = ['language', 'region', 'realm', 'faction', 'race', 'wow_class', 'spec', 'covenant', 'soulbind'] def get_serializer(self, *args, **kwargs): # 列表接口仅保留id、name两个字段 if self.action == 'list': kwargs['fields'] = ['id', 'name'] return super().get_serializer(*args, **kwargs)
方案对比:
- 两种方案最终返回效果完全一致,都不会破坏你现有的搜索、过滤功能
- 方案1的代码边界更清晰,列表、详情的字段定义独立可追溯,适合长期维护的项目
- 方案2没有冗余的序列化器类定义,适合已经大量复用全量序列化器的存量项目
- 如果后续需要优化列表接口的数据库查询性能,可以在
list对应的queryset里结合only('id', 'name')减少查询的字段数量,和序列化层的逻辑互不冲突
内容的提问来源于stack exchange,提问作者Akond
相关产品推荐
相关产品推荐

