我的路由中需要什么base_name参数才能使这个Django API工作？

Question

我正在构建一个Django应用程序,它公开了一个REST API,用户可以通过它查询我的应用程序的模型.我按照这里的说明操作.

我的路线在myApp的url.py中看起来像这样:

from rest_framework import routers
router = routers.DefaultRouter()    router.register(r'myObjects/(?P<id>\d+)/?$', views.MyObjectsViewSet)
url(r'^api/', include(router.urls)),

我的模型看起来像这样:

class MyObject(models.Model):
    name = models.TextField()

我的Serializer看起来像这样:

class MyObjectSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = MyObject
    fields = ('id', 'name',)

我的Viewset看起来像这样:

class MyObjectsViewSet(viewsets.ViewSet):

    def retrieve(self,request,pk=None):
        queryset = MyObjects.objects.get(pk=pk).customMyObjectList()

        if not queryset:
            return Response(status=status.HTTP_400_BAD_REQUEST)
        else:
            serializer = MyObjectSerializer(queryset)
            return Response(serializer.data,status=status.HTTP_200_OK)

当我点击/ api/myObjects/60 /时出现以下错误:

base_name参数未指定,并且无法自动确定视图集中的名称,因为它没有.model或.queryset属性.

我从这里了解到我的路线上需要一个base_name参数.但是从文档来看,我不清楚base_name参数的值应该是什么.有人可以告诉我base_name的路径应该是什么样的？

Answer 1

尝试在urls.py中执行此操作.第三个参数'Person'可以是你想要的任何东西.

router.register(r'person/food', views.PersonViewSet, 'Person')

Answer 2

也许你只需要base_name为你的路由器设置参数的名称:MyObject在你的情况下.

router.register(r'myObjects/(?P<id>\d+)/?$', views.MyObjectsViewSet, base_name="MyObject")

http://www.django-rest-framework.org/api-guide/routers/#Usage

Answer 3

让我解释一下,为什么我们首先需要一个base_name然后让我们进入base_name的可能值.

如果你使用Django的网址不前的休息框架(DRF),你就已经指定它是这样的:

urlpatterns = [
    url(r'myObjects/(?P<id>\d+)/?$', views.MyObjectsListView.as_view(), name='myobject-list'),
    url(r'myObjects/(?P<id>\d+)/?$', views.MyObjectsDetailView.as_view(), name='myobject-detail'),
]

在这里,如果你看到,有一个name参数,用于标识当前命名空间(即app)中的url .

这正是django-rest-framework自动尝试做的事情,因为drf知道视图是列表还是详细信息(因为视图集).它只需要附加一些前缀来区分网址.这就是base_name(前缀)的目的.

在大多数情况下,您可以将URL或资源名称指定为base_name.在您的情况下,base_name = myobject.DRF将生成base_name + view_type作为名称参数,如myobject_list和myobject_detail.

注意:通常,base_name将自动从queryset字段(从视图)获取,因为它对于视图集中的所有视图类型都是相同的.但是如果指定get_queryset方法而不是queryset,则可能意味着您对不同的视图类型(如list,detail)有不同的查询集.因此,DRF将要求您为资源的所有视图类型指定公共base_name.

Answer 4

另一种解决方案可能是使用 ModelViewSet ，它将自动从模型中派生基本名称。

只需确定并告诉它使用哪个模型：

由于 ModelViewSet 扩展了 GenericAPIView，因此您通常需要至少提供 queryset 和 serializer_class 属性，或模型属性快捷方式。