如何无需逐改序列化器实现DRF可浏览API的选项返回功能

现有代码结构 #

模型定义 #

from enum import Enum
from django.db import models

class YearInSchool(Enum):
    FRESHMAN = 'FR'
    SOPHOMORE = 'SO'
    JUNIOR = 'JR'
    SENIOR = 'SR'
    GRADUATE = 'GR'

    @classmethod
    def choices(cls):
        return ((i.name, i.value) for i in cls)


class Student(models.Model):
    year_in_school = models.CharField(
        max_length=2,
        choices=YearInSchool.choices(),
    )

class MyModel(models.Model):
    # 其余业务字段省略
    year = models.ForeignKey(Student, blank=True, null=True, on_delete=models.SET_NULL)

现有视图实现 #

from rest_framework import generics, serializers

class GetStudentDetails(generics.RetrieveUpdateDestroyAPIView):
    class StudentSerializer(serializers.ModelSerializer):
        class Meta:
            model = Student
            fields = '__all__'

    queryset = Student.objects.all()
    serializer_class = StudentSerializer
    lookup_field = 'year_in_school'

当前存在的问题 #

接口默认返回时，choices字段、外键字段仅返回数据库存储的原始值/关联主键，示例如下：

{
    // 其余字段省略
    "year": 1
}

期望效果 #

单次GET请求即可同时返回字段的当前选中值、全部可选选项，返回结构示例：

{
    // 其余字段省略
    "year": {
        "selected": "FR",
        "choices": {
            "FRESHMAN": "FR",
            "SOPHOMORE": "SO",
            "JUNIOR": "JR",
            "SENIOR": "SR",
            "GRADUATE": "GR"
        }
    }
}

不需要为跨多模型的数百个字段逐个修改序列化器添加冗余字段，直接支撑前端React应用复刻DRF可浏览API的下拉选择、值预填充交互。

DRF自带的可浏览API本身已经实现了字段选项拉取、选中值匹配的全部逻辑，完全可以复用这套内部机制做全局扩展，不需要逐字段加配置：

• 实现通用序列化器基类，重写to_representation方法，自动识别两类字段做结构转换：
  • 带choices属性的选择字段：直接读取模型字段上的选项集合，搭配实例当前值组装目标结构
  • 多对一外键字段：读取关联模型的可用查询集（可按需对齐业务权限、过滤规则），搭配当前关联实例的主键组装目标结构
    基类参考代码：

  from rest_framework import serializers
  
  class ChoiceEnabledModelSerializer(serializers.ModelSerializer):
      def to_representation(self, instance):
          ret = super().to_representation(instance)
          model_meta = self.Meta.model._meta
          # 读取序列化器上的自定义配置，支持灵活排除字段、自定义外键查询集
          exclude_choices = getattr(self.Meta, 'exclude_choices', [])
          fk_querysets = getattr(self.Meta, 'foreignkey_querysets', {})
  
          for field in model_meta.get_fields():
              field_name = field.name
              if field_name in exclude_choices:
                  continue
              
              # 处理choices选择字段
              if getattr(field, 'choices', None):
                  ret[field_name] = {
                      "selected": getattr(instance, field_name),
                      "choices": dict(field.choices)
                  }
              
              # 处理外键字段
              if field.many_to_one and field.is_relation:
                  related_obj = getattr(instance, field_name)
                  # 优先使用序列化器自定义的外键查询集，否则默认取全部关联对象
                  qs = fk_querysets.get(field_name, field.related_model.objects.all())
                  ret[field_name] = {
                      "selected": related_obj.pk if related_obj else None,
                      "choices": {str(obj.pk): str(obj) for obj in qs}
                  }
          return ret
  

• 所有业务序列化器直接继承这个基类即可，原有写入逻辑、字段定义完全不需要修改，返回结构自动符合要求：

  class StudentSerializer(ChoiceEnabledModelSerializer):
      class Meta:
          model = Student
          fields = '__all__'
          # 可选：不需要返回选项的字段加入列表
          # exclude_choices = ['create_time']
          # 可选：指定外键的过滤规则
          # foreignkey_querysets = {
          #     "year": Student.objects.filter(is_active=True)
          # }
  

• 如果需要支持写入时兼容原有传参格式，不需要修改序列化器的字段校验逻辑，to_representation仅控制读接口的返回结构，POST/PUT/PATCH请求的传参规则和原来完全一致，不会增加前端对接成本。

该方案和DRF可浏览API的实现逻辑一致，没有重复造轮子，新增字段不需要做任何额外配置就可以自动返回选项和选中值，维护成本极低。如果外键数据量较大，可以在基类里加缓存、分页逻辑，避免全表查询。

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