python - Django REST : How to use Router in application level urls. py？

Question

我的 Django 项目结构:

mysite/
    mysite/
        ...
        urls.py
    scradeweb/
        ...
        models.py
        serializers.py
        views.py
        urls.py
    manage.py

如果我在项目级 urls.py (mysite/urls.py) 中使用 Django REST router，如下所示，一切正常:

# mysite/urls.py
from django.conf.urls import patterns, include, url
from django.contrib import admin
from .settings import USER_CREATED_APPS
from rest_framework.routers import DefaultRouter
from scradeweb import views

router = DefaultRouter()
router.register(r'threads', views.ThreadViewSet, )
router.register(r'posts', views.PostViewSet)

urlpatterns = patterns('',
                url(r'^admin/', include(admin.site.urls)),
                url(r'api-auth/', include('rest_framework.urls', namespace='rest_framework')),
                url(r'scradeweb/', include('scradeweb.urls', namespace='scradeweb')),
                url(r'^', include(router.urls)),
                )

我喜欢将所有与我的应用程序 (scradweb) 相关的代码保存在它的 目录，所以我将 router 移动到 scradeweb/urls.py:

# scradeweb/urls.py
from django.conf.urls import url, patterns, include
from scradeweb import views
from rest_framework.routers import DefaultRouter


router = DefaultRouter()
router.register(r'threads', views.ThreadViewSet, )
router.register(r'posts', views.PostViewSet)

urlpatterns = router.urls

当我转到 http://127.0.0.1:8000/scradeweb/posts/ 时，它引发了异常:

ImproperlyConfigured: Could not resolve URL for hyperlinked relationship using view name "thread-detail". 
You may have failed to include the related model in your API, or incorrectly configured the `lookup_field` attribute on this field.

为什么不起作用？

这是我的scradeweb/models.py

class Thread(models.Model):

    thread_id = models.IntegerField()
    sticky = models.NullBooleanField()
    prefix = models.CharField(max_length=255)
    title = models.CharField(max_length=255)
    start_time = models.DateTimeField()
    author = models.CharField(max_length=255)
    url = models.URLField(unique=True)
    forum = models.ForeignKey(Forum, related_name='threads')

    class Meta:
        ordering = ('start_time', )


class Post(models.Model):

    post_id = models.IntegerField()
    url = models.URLField(unique=True)
    post_number = models.IntegerField()
    start_time = models.DateTimeField(blank=True)
    last_edited_time = models.DateTimeField(blank=True, null=True)
    author = models.CharField(max_length=255, blank=True)
    content = models.TextField(blank=True)
    thread = models.ForeignKey(Thread, related_name='posts')

    class Meta:
        ordering = ('post_number', )

scradeweb/serializers.py:

from rest_framework import serializers
from scradeweb.models import Thread, Post


class ThreadSerializer(serializers.HyperlinkedModelSerializer):

    posts = \
        serializers.HyperlinkedRelatedField(
            many=True,
            read_only=True,
            view_name='post-detail',
        )

    class Meta:

        model = Thread
        fields = ('pk', 'thread_id', 'title', 'url', 'posts')
        read_only_fields = ('thread_id', )


class PostSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Post

scradeweb/views.py:

...

class ThreadViewSet(viewsets.ReadOnlyModelViewSet):

    queryset = Thread.objects.all()
    serializer_class = ThreadSerializer


class PostViewSet(viewsets.ModelViewSet):

    queryset = Post.objects.all()
    serializer_class = PostSerializer

Answer 1

这里的问题是您正在使用带有命名空间的 Django REST Framework。许多组件不能很好地与它们配合使用，这并不意味着它们不能使用，因此您需要通过大量手动工作来解决这些问题。主要问题在于超链接关系 (Hyperlinked*Field)，因为它们必须反转 View ，并且需要指定命名空间。

首先要从路由器级别开始，目前不支持 namespace 。这只是 DefaultRouter 的问题，因为它将构建包含反向 url 列表的索引页面，这将立即触发错误。 已修复in the upcoming release ，但现在你还没有它。在最好的情况下(DRF 3.0+)，索引页面将完全为空(或指向不正确的 url)，在最坏的情况下(DRF 2.x)它总是会触发内部服务器错误。

第二个要看的地方是序列化器字段。默认情况下，HyperlinkedModelSerializer 将自动生成具有非命名空间 url 的 HyperlinkedRelatedField 和 HyperlinkedIdentityField 字段。当您使用命名空间时，您必须覆盖所有这些自动生成的字段。这通常意味着您最好不要使用 HyperlinkedModelSerializer，而是使用 ModelSerializer 控制输出。

首先(也是最简单的)要修复的是为所有对象自动生成的 url 字段。这是自动生成的，view_name 设置为详细信息页面(在本例中为 thread-detail)，没有命名空间。您将需要覆盖 view_name 并在其前面包含命名空间(因此在这种情况下为 scradeweb:thread-detail)。

class ThreadSerializer(serializers.ModelSerializer):
    url = serializers.HyperlinkedIdentityField(
        view_name="scradeweb:thread-detail",
    )

您还需要覆盖所有自动生成的相关字段。这对于可写字段来说稍微困难一些，但我总是建议在这些情况下查看 repr(MySerializer()) 以查看自动生成字段的参数。对于只读字段，只需复制默认参数并再次更改 view_name。

class ThreadSerializer(serializers.ModelSerializer):
    posts = serializers.HyperlinkedRelatedField(
        many=True,
        read_only=True,
        view_name='scradeweb:post-detail',
    )

这将需要为所有字段完成，并且看起来 Django REST Framework 不会在不久的将来添加自动执行此操作的能力。虽然一开始这并不令人愉快，但它会给您一个很好的机会来欣赏 DRF 之前自动为您所做的一切。