如何在路由器上注册单个视图(而不是视图集)?

时间:2015-05-22 05:51:25

标签: python django django-rest-framework

我正在使用Django REST框架并且一直在尝试创建一个返回一小部分信息的视图,并将其注册到我的路由器上。

我有四个存储信息的模型,所有模型都有一个created_time字段。我试图在一个视图中创建一个返回最新对象(基于created_time)的视图,其中只返回四个创建时间。

因此,视图中可能的JSON输出看起来像

{
    "publish_updatetime": "2015.05.20 11:53",
    "meeting_updatetime": "2015.05.20 11:32",
    "training_updatetime": "2015.05.20 15:25",
    "exhibiting_updatetime": "2015.05.19 16:23"
}

我也希望在我的路由器上注册此视图,因此在加载API根目录时会显示其余的端点。

router.register(r'updatetime', views.UpdateTimeView)

以下是我尝试使用的四种模型

class Publish(models.Model):
    user = models.ForeignKey(MyUser)
    name = models.CharField(max_length=50)
    created_time = models.DateTimeField( default=datetime.now)

class Meeting(models.Model):
    user = models.ForeignKey(MyUser)
    name = models.CharField(max_length=50)
    file_addr = models.FileField(upload_to=get_file_path)
    created_time = models.DateTimeField(default=datetime.now)

class Training(models.Model):
    user = models.ForeignKey(MyUser)
    name = models.CharField(max_length=50)
    image = models.ImageField(upload_to=get_file_path, max_length=255)
    created_time = models.DateTimeField(default=datetime.now)

class Exhibiting(models.Model):
    user = models.ForeignKey(MyUser)
    name = models.CharField(max_length=50)
    file_addr = models.FileField(upload_to=get_file_path)
    created_time = models.DateTimeField(default=datetime.now)

有可能这样做吗?它将如何完成?

2 个答案:

答案 0 :(得分:57)

路由器工作with a ViewSet并且不是为普通视图设计的,但这并不意味着您无法在普通视图中使用它们。通常它们与模型一起使用(和ModelViewSet),但是使用GenericViewSet(如果您通常使用GenericAPIView)和ViewSet时,它们可以在没有它们的情况下使用(如果您只使用APIView)。

对于列表视图,请求方法映射到ViewSet方法,如此

  • GET - > list(self, request, format=None)
  • POST - > create(self, request, format=None)

对于详细视图(在网址中使用主键),请求方法使用以下地图

  • GET - > retrieve(self, request, pk, format=None)
  • PUT - > update(self, request, pk, format=None)
  • PATCH - > partial_update(self, request, pk, format=None)
  • DELETE - > destroy(self, request, pk, format=None)

因此,如果您想在路由器上使用这些请求方法中的任何一种,则需要覆盖正确的视图方法(因此list()代替get())。

现在,特别是在您的情况下,您通常会使用看起来像

APIView
class UpdateTimeView(APIView):

    def get(self, request, format=None):
        latest_publish = Publish.objects.latest('created_time')
        latest_meeting = Meeting.objects.latest('created_time')
        latest_training = Training.objects.latest('created_time')
        latest_exhibiting = Exhibiting.objects.latest('created_time')

        return Response({
            "publish_updatetime": latest_publish.created_time,
            "meeting_updatetime": latest_meeting.created_time,
            "training_updatetime": latest_training.created_time,
            "exhibiting_updatetime": latest_exhibiting.created_time,
        })

可比较的ViewSet将是

class UpdateTimeViewSet(ViewSet):

    def list(self, request, format=None):
        latest_publish = Publish.objects.latest('created_time')
        latest_meeting = Meeting.objects.latest('created_time')
        latest_training = Training.objects.latest('created_time')
        latest_exhibiting = Exhibiting.objects.latest('created_time')

        return Response({
            "publish_updatetime": latest_publish.created_time,
            "meeting_updatetime": latest_meeting.created_time,
            "training_updatetime": latest_training.created_time,
            "exhibiting_updatetime": latest_exhibiting.created_time,
        })

请注意两项必要的更改:APIView - > ViewSetget - > list。我还更新了名称,表明它不仅仅是普通视图(因为ViewSet不能以相同的方式初始化),但这不是必需的。

因此,使用这个新视图,您可以像在其他任何方式一样在路由器中注册它。这里需要base_name,因此可以生成网址名称(通常这会从查询集中提取)。

router.register(r'updatetime', views.UpdateTimeViewSet, base_name='updatetime')

现在,updatetime端点将在API根目录中可用,您可以通过调用端点(一个简单的GET请求)来获取最新时间。

答案 1 :(得分:0)

还有一种方法可以做到:

urlpatterns = [
    # ... 
    url(r'^you_path/', include(router.urls)),
    url(r'^you_path/you_sub_path', views.UpdateTimeView.as_view()),
    # ... 
]

但像Swagger这样的东西不适用于那个