10

我有一个电视频道模型并创建了一个 django-restframework viewlet,它为我提供了一个开箱即用的列表和详细视图。在顶部,我添加了两个名为 all_events 和 now_and_next_event 的自定义单对象视图,如下所述:Marking extra methods for routing。到目前为止效果很好。

class ChannelViewSet(viewsets.ModelViewSet):
    """
    A viewset for viewing and editing channel instances.
    """
    serializer_class = serializers.ChannelSerializer
    queryset = Channel.objects.all()

    @link()
    def now_and_next_event(self, request, pk):
        ''' Show current and next event of single channel. '''
        ...

现在我想添加一个自定义视图,它不是单对象视图,而是类似列表的视图:

class CurrentEvents(generics.ListCreateAPIView):
    ''' Show current event of all channels. '''
    model = Event
    serializer_class = serializers.EventSerializer

    def get(self, request):
        ...

当我禁用我的 viewlet 并为其添加手动 url 模式时,它也可以正常工作。但是我还没有想出如何让它们都使用相同的 'api/channel/' 前缀,或者我想要更多,如何将自定义列表视图类添加到我的 viewlet 中。

这是我的 viewlet url 模式:

^api/channel/$ [name='channel-list']
^api/channel/(?P<pk>[^/]+)/$ [name='channel-detail']
^api/channel/(?P<pk>[^/]+)/all_events/$ [name='channel-all-events']
^api/channel/(?P<pk>[^/]+)/now_and_next_event/$ [name='channel-now-and-next-event']

我想访问我的列表视图,例如:

^api/channel/current_events/$ [name='event-current']
4

2 回答 2

9

从 Django REST Framework 2.4 开始,您现在可以使用 装饰ViewSet方法@list_route来获得您想要的东西。

从文档

@detail_route装饰器包含在其pkURL 模式中,适用于需要单个实例的方法。@list_route装饰器适用于对对象列表进行操作的方法。

这些替换了只能作为详细路由工作的旧的@link和装饰器。@action

于 2014-12-20T21:58:08.097 回答
6

如果你想要对象列表,那么你需要 ListApiView 中的列表方法:例如,模型是 ModelName,序列化程序类是 SerializerClassname,那么代码将是:

class ExampleView(ListAPIView):
    model = ModelNmae
    serializer_class = SerializerClassName
    permission_classes = (IsAuthenticated,)

    def get_queryset(self):
        """
        """
        queryset = ModelName.objects.all()
        q = self.request.query_params.get('q', None)
        if q is not None:
            queryset =queryset.filter(name__icontains=q)
        return queryset

    def list(self, request, *args, **kwargs):
        queryset = self.filter_queryset(self.get_queryset())

        page = self.paginate_queryset(queryset)
        if page is not None:
            serializer = self.get_serializer(page, many=True)
            return self.get_paginated_response(serializer.data)

        serializer = self.get_serializer(queryset, many=True)
        result = [ x.values()[0] for x in serializer.data ]
        return Response(result)
于 2016-10-09T08:32:06.160 回答