我有一些带有时间戳字段的模型:
型号.py
class Event(models.Model):
event_type = models.CharField(
max_length=100,
choices=EVENT_TYPE_CHOICES,
verbose_name=_("Event Type")
)
event_model = models.CharField(
max_length=100,
choices=EVENT_MODEL_CHOICES,
verbose_name=_("Event Model")
)
timestamp = models.DateTimeField(auto_now=True, verbose_name=_("Timestamp"))
然后,我将使用django-rest框架为此类创建一个API端点,django-filter提供如下过滤功能:
from .models import Event
from .serializers import EventSerializer
from rest_framework import viewsets, filters
from rest_framework import renderers
from rest_framework_csv import renderers as csv_renderers
class EventsView(viewsets.ReadOnlyModelViewSet):
"""
A read only view that returns all audit events in JSON or CSV.
"""
queryset = Event.objects.all()
renderer_classes = (csv_renderers.CSVRenderer, renderers.JSONRenderer)
serializer_class = EventSerializer
filter_backends = (filters.DjangoFilterBackend,)
filter_fields = ('event_type', 'event_model', 'timestamp')
使用以下设置:
REST_FRAMEWORK = {
'DEFAULT_FILTER_BACKENDS': ('rest_framework.filters.DjangoFilterBackend',),
}
我可以按
event_type
和event_model
进行筛选,但按时间戳字段进行筛选时遇到问题。本质上,我想进行一个相当于以下内容的API调用:AuditEvent.objects.filter(timestamp__gte='2016-01-02 00:00+0000')
我希望我可以这样做:
response = self.client.get("/api/v1/events/?timestamp=2016-01-02 00:00+0000", **{'HTTP_ACCEPT': 'application/json'})
尽管这是不正确的。如何进行返回时间戳大于或等于某个值的所有对象的API调用?
最佳答案
要扩展flaiming的答案,如果您只想通过iso-datetime格式进行过滤,那么覆盖默认值以始终使用IsoDateTimeFilter
。这可以通过每个过滤器组来完成,例如
from django.db import models as django_models
import django_filters
from rest_framework import filters
from rest_framework import viewsets
class EventFilter(filters.FilterSet):
class Meta:
model = Event
fields = {
'timestamp': ('lte', 'gte')
}
filter_overrides = {
django_models.DateTimeField: {
'filter_class': django_filters.IsoDateTimeFilter
},
}
class EventsView(viewsets.ReadOnlyModelViewSet):
...
filter_class = EventFilter
然后,您就不必为每个查找表达式和每个字段设置不同的过滤器了。