在drf-yasg中自定义ModelChoiceFilter的显示方式

在使用Django REST框架开发API时，drf-yasg是一个常用的工具，它可以自动生成Swagger/OpenAPI文档。然而，在处理Django-filter的ModelChoiceFilter时，开发者可能会遇到显示格式不符合预期的问题。

问题背景

默认情况下，drf-yasg会将ModelChoiceFilter渲染为普通的文本输入框，而不是开发者期望的下拉选择框。这是因为drf-yasg无法自动识别ModelChoiceFilter应该以选择框的形式展示。

解决方案

要解决这个问题，我们需要创建一个自定义的Filter类，重写其字段类型和模式定义。以下是实现这一目标的详细步骤：

1. 创建自定义Filter类：继承自ModelChoiceFilter，并重写相关方法
2. 指定字段类型：明确告诉drf-yasg这是一个选择字段
3. 提供选项值：从模型中获取所有可能的选项值

from django_filters import rest_framework as filters
from drf_yasg import openapi

class ModelChoiceField(filters.ModelChoiceFilter):
    field_class = filters.ModelChoiceFilter.field_class

    def get_schema_fields(self, view):
        field = super().get_schema_fields(view)[0]
        field['type'] = 'integer'  # 假设主键是整数类型
        field['enum'] = list(self.queryset.values_list('id', flat=True))
        return [field]

使用示例

在实际应用中，我们可以这样使用自定义的Filter类：

class ClinicFilter(filters.FilterSet):
    test = ModelChoiceField(queryset=Clinic.objects.all())

实现原理

1. 继承机制：我们继承了ModelChoiceFilter的所有功能
2. 字段类型重写：通过get_schema_fields方法，我们修改了API文档中的字段定义
3. 选项枚举：从queryset中提取所有可能的ID值，作为enum选项

注意事项

1. 如果模型的主键不是整数类型，需要相应调整field['type']的值
2. 对于大型数据集，枚举所有选项可能会影响性能，可以考虑分页或其他优化方案
3. 确保queryset已经被正确初始化，否则values_list调用会失败

通过这种方式，我们可以在保持ModelChoiceFilter原有功能的同时，在API文档中获得更友好的展示效果。