Python Django REST:如何在应用程序级URL.py中使用路由器?
My Django项目结构:Python Django REST:如何在应用程序级URL.py中使用路由器?,python,django,django-rest-framework,Python,Django,Django Rest Framework,My Django项目结构: mysite/ mysite/ ... urls.py scradeweb/ ... models.py serializers.py views.py urls.py manage.py 如果我在项目级url.py(mysite/url.py)中使用Django RESTrouter,如下图所示,一切正常: # mysite/u
mysite/
mysite/
...
urls.py
scradeweb/
...
models.py
serializers.py
views.py
urls.py
manage.py
如果我在项目级url.py(mysite/url.py
)中使用Django RESTrouter
,如下图所示,一切正常:
# 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)),
)
我喜欢将所有与我的应用程序(scradeweb
)相关的代码保存在它的内部
目录,因此我将router
移动到scradeweb/url.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
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
...
class ThreadViewSet(viewsets.ReadOnlyModelViewSet):
queryset = Thread.objects.all()
serializer_class = ThreadSerializer
class PostViewSet(viewsets.ModelViewSet):
queryset = Post.objects.all()
serializer_class = PostSerializer
当我转到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
:
# 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
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
...
class ThreadViewSet(viewsets.ReadOnlyModelViewSet):
queryset = Thread.objects.all()
serializer_class = ThreadSerializer
class PostViewSet(viewsets.ModelViewSet):
queryset = Post.objects.all()
serializer_class = PostSerializer
scradeweb/views.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
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
...
class ThreadViewSet(viewsets.ReadOnlyModelViewSet):
queryset = Thread.objects.all()
serializer_class = ThreadSerializer
class PostViewSet(viewsets.ModelViewSet):
queryset = Post.objects.all()
serializer_class = PostSerializer
这里的问题是,您正在使用带有名称空间的Django REST框架。许多组件不能很好地使用它们,这并不意味着它们不能被使用,因此您需要通过大量的手动工作来解决这些问题。主要问题是超链接关系(
hyperlinked*Field
s),因为它们必须反转视图,这需要指定名称空间
首先从路由器级别开始,目前不支持名称空间。这只是DefaultRouter
的一个问题,因为它将构建包含反向URL列表的索引页,这将立即触发错误这已被修复,但目前你还没有它。在最好的情况下(DRF 3.0+),索引页将完全为空(或指向不正确的URL),在最坏的情况下(DRF 2.x),它将始终触发内部服务器错误
第二个要看的地方是序列化程序字段。默认情况下,HyperlinkedModelSerializer
将自动生成带有非命名空间URL的HyperlinkedRelatedField
和hyperlinkedEntityField
字段。使用名称空间时,必须覆盖所有这些自动生成的字段。这通常意味着您最好不要使用超链接ModelSerializer,而是使用ModelSerializer
控制输出
首先(也是最简单的)要修复的是为所有对象自动生成的url
字段。这是在将view\u name
设置为详细信息页面(本例中为thread detail
)时自动生成的,没有名称空间。您需要覆盖视图\ u name
并在其前面包含名称空间(在本例中是scradeweb:threaddetail
)
您还需要覆盖所有自动生成的相关字段。对于可写字段来说,这稍微有点困难,但我始终建议在这些情况下查看repr(MySerializer())
,以查看自动生成的字段的参数。对于只读字段,只需复制默认参数并再次更改view\u name
class ThreadSerializer(serializers.ModelSerializer):
posts = serializers.HyperlinkedRelatedField(
many=True,
read_only=True,
view_name='scradeweb:post-detail',
)
所有字段都需要这样做,而且Django REST框架似乎不会在不久的将来自动添加这样的功能。虽然这在一开始并不令人愉快,但它将为您提供一个很好的机会来欣赏DRF以前为您自动完成的一切。视图在哪里=>
线程详细信息
?@LearningNeverStops将生成线程详细信息
,线程列表
,发布详细信息
,post list
来自视图集。你在我的网站url中包括srcradeweb/url.py吗?@user2309693是的,我仍然保留url(r'scradeweb/',include('scradeweb.url',namespace='scradeweb'))
在mysite/url.py
中。你能展示一下论坛序列化程序吗