时间戳

首页 > 解决方案 > DjangoRestFramework : 为 ModelViewSet 的单独功能创建单独的 URL

python - DjangoRestFramework : 为 ModelViewSet 的单独功能创建单独的 URL

问题描述

我在 Django Rest Framework 中有一个 ModelViewset：

class UserViewset(viewsets.ModelViewSet):
    queryset = models.User
    serializer_class = serializers.User

它的路由器：

router = routers.DefaultRouter()
router.register(r'user', views.UserViewset)

我想要此 Viewset 的创建、更新、列出和检索功能的单独 URL：

/user/register/            : POST (create new user)
/user/<pk>/profile         : GET (retrieve profile of user)
/user/<pk>/profile/update/ : PATCH (update profile of user)
/user/list                 : GET (get list of users)

如何实现（使用路由器或 URL）？

标签： pythondjangodjango-rest-frameworkdjango-urlsdjango-rest-viewsets

解决方案

你可以这样做：

from rest_framework.decorators import action


class UserViewset(viewsets.ModelViewSet):
    queryset = models.User
    serializer_class = serializers.User

    # GET: /user/register/
    @action(detail=False, url_path='register/')
    def user_register(self, request):
        ...

    # GET: /user/<pk>/profile
    @action(detail=True, methods=['get'])
    def profile(self, request, pk=None):
        ...

    # PATCH: /user/<pk>/profile/update/
    @action(detail=True, methods=['patch'], url_path='profile/update/')
    def profile_update(self, request, pk=None):
        ...

    # GET: /user/list 
    @action(detail=False, url_path='list/')
    def user_list(self, request, *args, **kwargs):
        # You can do super().list(request, *args, **kwargs) here, up to you
        ...

您可以从以下位置了解更多信息：

https://www.django-rest-framework.org/api-guide/viewsets/#marking-extra-actions-for-routing https://www.django-rest-framework.org/api-guide/routers/ #routing-for-extra-actions

推荐阅读