24

Django Rest Framework を使用したルーティングAPIViews(つまり、ない) の一般的なパターンはありますか? ViewSets

たとえば、オプションの引数を取る API ビューがあるとします。

class ReportView(APIView):
    def get(self, request, report_name=None):
         # … stuff …
         return Response(report)

標準の Django URL ルーターを作成する以外に、そのビューをルーティングするための標準的なパターンはありますか?

4

2 に答える 2

15

シンプルな API ビューを追加できることは、root-apiビューに URL を表示するのに非常に役立ちます。

DefaultRouter以下は、ビューセットだけでなく単純な API ビューも登録できる最も単純な拡張です。

from django.conf.urls import url
from rest_framework import routers, viewsets
from rest_framework.urlpatterns import format_suffix_patterns

class DefaultRouterWithSimpleViews(routers.DefaultRouter):
    """
    Extends functionality of DefaultRouter adding possibility
    to register simple API views, not just Viewsets.
    """

    def get_routes(self, viewset):
        """
        Checks if the viewset is an instance of ViewSet,
        otherwise assumes it's a simple view and does not run
        original `get_routes` code.
        """
        if issubclass(viewset, viewsets.ViewSetMixin):
            return super(DefaultRouterWithSimpleViews, self).get_routes(viewset)

        return []

    def get_urls(self):
        """
        Append non-viewset views to the urls
        generated by the original `get_urls` method.
        """    
        # URLs for simple views
        ret = []
        for prefix, viewset, basename in self.registry:

            # Skip viewsets
            if issubclass(viewset, viewsets.ViewSetMixin):
                continue

            # URL regex
            regex = '{prefix}{trailing_slash}$'.format(
                prefix=prefix,
                trailing_slash=self.trailing_slash
            )

            # The view name has to have suffix "-list" due to specifics
            # of the DefaultRouter implementation.
            ret.append(url(
                regex, viewset.as_view(),
                name='{0}-list'.format(basename)
            ))

        # Format suffixes
        ret = format_suffix_patterns(ret, allowed=['json', 'html'])

        # Prepend URLs for viewsets and return
        return super(DefaultRouterWithSimpleViews, self).get_urls() + ret

これで、シンプルな Django ビューを残りのフレームワーク ViewSets と一緒に使用できるようになりました。

router = DefaultRouterWithSimpleViews()
router.register(r'users', UserViewSet, 'users')                # <- Viewset!         
router.register(r'reset-pwd', ResetPasswordView, 'reset_pwd')  # <- Simple view!
urlpatterns = router.urls

更新:形式サフィックスのサポートを追加 (thanks to alexander-klimenko )

于 2015-11-28T12:00:13.263 に答える
9

標準の Django URL ルーターを作成する以外に、そのビューをルーティングするための標準的なパターンはありますか?

ビューセットとルーターは、標準化されたルーティングが必要な場合のパターンです。

ビューを使用している場合は、通常の Django URLconf を使用してください。

于 2013-09-16T08:41:51.083 に答える