Django REST：ルータをアプリケーションレベルの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)), 
       ) 

私はすべてのアプリケーションを保ちたいと（scradeweb）その ディレクトリ内の関連するコード、私は移動routerscradeweb/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フレームワークを使用していることです。多くのコンポーネントがうまく動作しません。は、を使用できないというわけではありませんので、多くの手動作業を行うことで問題を回避する必要があります。主な問題は、ハイパーリンクされたリレーションシップ（Hyperlinked*Field）です。なぜなら、ビューを逆にする必要があり、ネームスペースが指定されている必要があるからです。

最初にルータのレベルがであり、現在は名前空間をサポートしていません。これは、DefaultRouterの唯一の問題です。逆URLのリストを含むインデックスページが作成されるため、すぐにエラーが発生します。 これは修正されましたin the upcoming release、しかし今のところあなたはそれなしで立ち往生しています。最高（DRF 3.0以降）では、索引ページは完全に空（または誤ったURLを指す）になります。最悪の場合（DRF 2.x）のシナリオでは、常に内部サーバーエラーが発生します。

もう1つは、シリアライザのフィールドです。既定では、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フレームワークは、近い将来にそれを自動的に行う機能を追加していく予定のようにそれが見えません。これは最初は楽しいものではありませんが、DRFが以前にあなたにしてくれたすべてのことを自動的に評価する素晴らしい機会を提供します。