如何将Model中的Property作为API接口的过滤字段？

你已经定义了带有is_active属性的Auction模型、对应的序列化器和ModelViewSet，现在要把这个属性作为API的过滤字段——因为它不是数据库中的实际字段，默认的Django Filter不支持直接过滤，得通过自定义过滤器来实现，具体操作如下：

1. 确保安装并配置django-filter #

首先如果还没安装django-filter，先执行安装命令：

pip install django-filter

然后在项目的settings.py中添加配置：

INSTALLED_APPS = [
    # 其他已有的app
    'django_filters',
]

REST_FRAMEWORK = {
    # 其他配置
    'DEFAULT_FILTER_BACKENDS': [
        'django_filters.rest_framework.DjangoFilterBackend',
    ],
}

2. 自定义过滤器类 #

创建一个过滤器文件（比如filters.py），编写自定义的AuctionFilter类，通过method来实现is_active的过滤逻辑：

import django_filters
from .models import Auction
from django.utils import timezone

class AuctionFilter(django_filters.FilterSet):
    # 定义is_active的布尔过滤器，指定处理方法
    is_active = django_filters.BooleanFilter(method='filter_is_active')

    class Meta:
        model = Auction
        fields = ['is_active']  # 这里可以添加其他需要过滤的数据库字段

    def filter_is_active(self, queryset, name, value):
        # 根据传入的value（True/False）执行对应的过滤
        if value:
            # 筛选出未结束的拍卖（和模型中is_active的逻辑一致）
            return queryset.filter(finish_time__gt=timezone.now())
        else:
            # 筛选出已结束的拍卖
            return queryset.filter(finish_time__lte=timezone.now())

3. 在ViewSet中绑定过滤器 #

修改你的AuctionViewSet，指定使用上面的自定义过滤器：

from rest_framework import viewsets
from .models import Auction
from .serializers import AuctionSerializer
from .filters import AuctionFilter  # 导入自定义过滤器

class AuctionViewSet(viewsets.ModelViewSet):
    queryset = Auction.objects.all()
    serializer_class = AuctionSerializer
    filter_class = AuctionFilter  # 绑定过滤器类

这样就完成了配置，现在你可以通过API请求来过滤is_active字段了，比如：

• 获取所有活跃的拍卖：GET /api/auctions/?is_active=true
• 获取所有已结束的拍卖：GET /api/auctions/?is_active=false

这个方法的核心是把is_active属性的逻辑转移到过滤器的查询中，因为我们不能直接过滤模型的@property，只能通过数据库字段（这里是finish_time）来实现等价的过滤效果。

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