具有多个视图集和路由器的 Django Rest Framework 用于同一对象答案

【问题标题】：Django Rest Framework with multiple Viewsets and Routers for the same object具有多个视图集和路由器的 Django Rest Framework 用于同一对象
【发布时间】：2017-04-07 02:28:30
【问题描述】：

我在使用 Django Rest Framework 为同一个对象定义不同的视图集时遇到问题。以下是基于 DRF 快速入门的重现问题的最小示例。我正在使用 python 3.5 和最新的 DRF。

教程/快速入门/serializers.py

from django.contrib.auth.models import User
from rest_framework import serializers


class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ('url', 'username', 'email')

class UserMinimalSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ('url', 'username')

教程/快速入门/views.py

from django.contrib.auth.models import User
from rest_framework import viewsets
from tutorial.quickstart.serializers import UserSerializer, UserMinimalSerializer

class UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all().order_by('-date_joined')
    serializer_class = UserSerializer


class UserMinimalViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all().order_by('-date_joined')
    serializer_class = UserMinimalSerializer

教程/urls.py

from django.conf.urls import url, include
from rest_framework import routers
from tutorial.quickstart import views

router = routers.DefaultRouter()
router.register(r'users', views.UserViewSet)
router.register(r'users-minimal', views.UserMinimalViewSet) 

urlpatterns = [
    url(r'^', include(router.urls))
]

运行服务器并获取根目录时，您最终会得到：

HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "users": "http://127.0.0.1:8000/users-minimal/",
    "users-minimal": "http://127.0.0.1:8000/users-minimal/"
}

注意users 和users-minimal 都指向.../users-minimal/。

此外，当访问http://HOST:PORT/users/ 时，您会得到：

HTTP 200 OK
Allow: GET, POST, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "http://127.0.0.1:8000/users-minimal/2/",
            "username": "user2",
            "email": "user2@users.com"
        },
        {
            "url": "http://127.0.0.1:8000/users-minimal/1/",
            "username": "user1,
            "email": "user1@users.com"
        }
    ]
}

注意网址指向.../users-minimal/。

最后说明：我的问题有点类似于this one，但建议的解决方案对我不起作用，也没有说明为什么它应该首先起作用。

【问题讨论】：

标签： python django rest django-rest-framework

【解决方案1】：

简短回答：您必须将basename 参数添加到您的路由到users-minimal：

router = routers.DefaultRouter()
router.register(r'users', UserViewSet)
router.register(r'users-minimal', UserMinimalViewSet, basename='usersminimal')

通常 DRF 会自动从您的 queryset 生成 basename。这在DRF routers docs中有解释，搜索basename。

您的两个Viewsets 使用相同的queryset，因此最初具有相同的basename。这导致了您所看到的问题，即后来注册的ViewSet 将覆盖以前注册的ViewSet 的路由。当您在示例中更改 router.register 的顺序时，您可以看到这一点。

当您直接在 shell 中测试代码时，您可以看到路由的基本名称：

from rest_framework import routers
from tutorial.quickstart import views

router = routers.DefaultRouter()
router.register(r'users', views.UserViewSet)
router.register(r'users-minimal', views.UserMinimalViewSet)


> routers.urls
[<RegexURLPattern user-list ^minimal/$>,
<RegexURLPattern user-list ^minimal\.(?P<format>[a-z0-9]+)/?$>,
<RegexURLPattern user-detail ^minimal/(?P<pk>[^/.]+)/$>,
<RegexURLPattern user-detail ^minimal/(?P<pk>[^/.]+)\.(?P<format>[a-z0-9]+)/?$>,
<RegexURLPattern user-list ^users/$>,
<RegexURLPattern user-list ^users\.(?P<format>[a-z0-9]+)/?$>,
<RegexURLPattern user-detail ^users/(?P<pk>[^/.]+)/$>,
<RegexURLPattern user-detail ^users/(?P<pk>[^/.]+)\.(?P<format>[a-z0-9]+)/?$>,
<RegexURLPattern api-root ^$>,
<RegexURLPattern api-root ^\.(?P<format>[a-z0-9]+)/?$>]

【讨论】：