首页 文章

如何在Django rest框架中实现过滤器API

提问于
浏览
0

我正在尝试在django rest中实现过滤器api . 就像是 -

localhost:8000/api/v1/users/?email=abc.xzy@gmail.com/

因此它应该使用传递的过滤器搜索用户并返回结果 . 但是目前它正在返回所有用户 .

URLS.py

url(r'^api/v1/users/$',   UserViews.UserList.as_view(), name='userlist_view'),
    url(r'^api/v1/users/(?P<email>.+)/$', UserViews.UserList.as_view(), name='userList_view'),
    url(r'^api/v1/users/(?P<pk>[0-9]+)/$', UserViews.UserDetail.as_view(), name='userdetail_view'),

UserViews.py

class UserList(generics.ListAPIView):
    """
    List all users, or create a new user.
    """
    lookup_url_kwarg = "email"

    def get(self, request, format=None):
        if request.user.is_authenticated():
            users = User.objects.all()
            serializer = UserSerializer(users, many=True)
            return Response(serializer.data)
        return Response("User is not authenticated.", status=status.HTTP_400_BAD_REQUEST)

    def post(self, request, format=None):

        valid_paylaod, msg = UserListRepository.validations_create_user(request.data)
        if not valid_paylaod:
            return Response(msg, status=status.HTTP_400_BAD_REQUEST)

        result = UserListRepository.create_user_repo(request)

        if not result.success:
            return Response(str(result.msg), status=result.status )

        return Response(UserSerializer(result.data).data, status=result.status)

   def get_queryset(self):
    # It restricts the userlist by retunning users having emails passed in uery param
    user = self.request.user
    if user.is_authenticated():
         if 'email' in self.request.query_params:
            email = self.request.query_params.get('email', None)
            users = User.objects.get(email= email)
            if not users:
                return Response( "User Not found", status=status.HTTP_404_NOT_FOUND)
            else:
                return Response(UserSerializer(User.objects.all()).data, status.HTTP_200_OK, users)
        else:
            return Response(UserSerializer().data, status=result.status)
    else:
        return Response("User is not authenticated.", status=status.HTTP_400_BAD_REQUEST)

有人可以告诉为什么请求不会使用get_queryset()方法并转到UserList方法的get() . 在删除get方法时,请求转到get_queryset(self)方法 . 在调试时,我发现在返回语句之前我得到了有效的Response -

(Pdb) UserSerializer(result.data).data
{'parent_id': 2, 'id': 31, 'group_id': '4', 'last_name': 'user',         'email': 'agency22_user@agency22.com', 'organization_id': 0, 'first_name':  'agency22'}

但仍然在APi响应中,我得到以下错误:

Internal Server Error: /api/v1/users/
 Traceback (most recent call last):
 File "/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-packages/django/core/handlers/base.py", line 149, in get_response
response = self.process_exception_by_middleware(e, request)
 File "/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-packages/django/core/handlers/base.py", line 147, in get_response
response = wrapped_callback(request, *callback_args, **callback_kwargs)
Fi e "/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-packages/django/views/decorators/csrf.py", line 58, in wrapped_view
return view_func(*args, **kwargs)
File "/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-packages/django/views/generic/base.py", line 68, in view
return self.dispatch(request, *args, **kwargs)
 File "/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-packages/rest_framework/views.py", line 466, in dispatch
response = self.handle_exception(exc)
File "/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-packages/rest_framework/views.py", line 463, in dispatch
response = handler(request, *args, **kwargs)
File "/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-packages/rest_framework/generics.py", line 201, in get
return self.list(request, *args, **kwargs)
File "/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-packages/rest_framework/mixins.py", line 43, in list
if page is not None:
File "/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-packages/rest_framework/serializers.py", line 674, in data
ret = super(ListSerializer, self).data
File "/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-packages/rest_framework/serializers.py", line 239, in data
self._data = self.to_representation(self.instance)
File "/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-    packages/rest_framework/serializers.py", line 614, in to_representation
self.child.to_representation(item) for item in iterable
 File "/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-  packages/django/template/response.py", line 173, in __iter__
raise ContentNotRenderedError('The response content must be '
 django.template.response.ContentNotRenderedError: The response content          must be rendered before it can be iterated over.

我不清楚为什么 . 我要点击的API URL是:localhost:8000 / api / v1 / users?email =agency22_user@agency22.com

4 回答

  • 1

    看起来你正在使用来自django的 Response 而不是django-rest-framework .

    您必须从rest_framework.response导入响应

    from rest_framework.response import Response
    
  • 2

    问题是您要覆盖 ListAPIViewget 方法 . 此方法由GET请求调用 . get 的默认实现调用 ListModelMixin 的list方法,并调用 get_queryset

    def list(self, request, *args, **kwargs):
        queryset = self.filter_queryset(self.get_queryset())
    
        page = self.paginate_queryset(queryset)
        if page is not None:
            serializer = self.get_serializer(page, many=True)
            return self.get_paginated_response(serializer.data)
    
        serializer = self.get_serializer(queryset, many=True)
        return Response(serializer.data)
    

    如果覆盖此方法,则必须自己调用 get_queryset . 如果您只想检查用户是否经过身份验证,然后调用默认列表方法,您可以这样做:

    def get(self, request, format=None):
            if request.user.is_authenticated():
                return super(UserList, self).get(request, format)
            return Response("User is not authenticated.", status=status.HTTP_400_BAD_REQUEST)
    
  • 1

    在Django休息框架中,有一个如何使用过滤器的正确规范 . 所以你的用户类看起来像 .

    class UserList(generics.ListAPIView):
        """
        List all users, or create a new user.
        """
        lookup_url_kwarg = "email"
        serializer_class = UserSerializer
    
        def get(self, request, format=None):
            if request.user.is_authenticated():
                users = User.objects.all()
                serializer = UserSerializer(users, many=True)
                return Response(serializer.data)
            return Response("User is not authenticated.", status=status.HTTP_400_BAD_REQUEST)
    
        def post(self, request, format=None):
    
            valid_paylaod, msg = UserListRepository.validations_create_user(request.data)
            if not valid_paylaod:
                return Response(msg, status=status.HTTP_400_BAD_REQUEST)
    
            result = UserListRepository.create_user_repo(request)
    
            if not result.success:
                return Response(str(result.msg), status=result.status )
    
            return Response(UserSerializer(result.data).data, status=result.status)
    
        def get_queryset(self):
            email = self.request.query_params.get('email', None)
            return User.objects.filter(email=email)
    

    或者你可以尝试没有get_queryset . 链接会改变,更新的链接是:

    localhost:8000/api/v1/users/abc.xzy@gmail.com/

    并且更新的代码是

    class UserList(generics.ListCreateAPIView):
            """
            List all users, or create a new user.
            """
            lookup_url_kwarg = "email"
            serializer_class = UserSerializer
    
            def get(self, request, email,format=None):
                if request.user.is_authenticated():
                    user_details = User.objects.filter(email=email)
                    serializer = UserSerializer(user_details, many=True)
                    return Response(serializer.data, status=status.status.HTTP_200_OK)
                return Response("User is not authenticated.", status=status.HTTP_400_BAD_REQUEST)
    
            def post(self, request, format=None):
    
                valid_paylaod, msg = UserListRepository.validations_create_user(request.data)
                if not valid_paylaod:
                    return Response(msg, status=status.HTTP_400_BAD_REQUEST)
    
                result = UserListRepository.create_user_repo(request)
    
                if not result.success:
                    return Response(str(result.msg), status=result.status )
    
                return Response(UserSerializer(result.data).data, status=result.status)
    
  • 1

    我对UrlConf感到困惑:

    url(r'^api/v1/users/$', UserViews.UserList.as_view(), name='userlist_view'),
    url(r'^api/v1/users/(?P<email>.+)/$', UserViews.UserList.as_view(), name='userList_view'),
    
    • 第一个是 localhost:8000/api/v1/users/

    • 第二个是 localhost:8000/api/v1/users/abc.xzy@gmail.com/ 而不是 localhost:8000/api/v1/users/?email=abc.xzy@gmail.com/ ,这是一个查询参数而不是kwargs,如果你想查看这个use query parameter

    class UserList(generics.ListAPIView):
    """
    List all users, or create a new user.
    """
    lookup_url_kwarg = "email"
    serializer_class = UserSerializer
    
    def post(self, request, format=None):
    
        valid_paylaod, msg = UserListRepository.validations_create_user(request.data)
        if not valid_paylaod:
            return Response(msg, status=status.HTTP_400_BAD_REQUEST)
    
        result = UserListRepository.create_user_repo(request)
    
        if not result.success:
            return Response(str(result.msg), status=result.status )
    
        return Response(UserSerializer(result.data).data, status=result.status)
    def get_queryset(self):
    """
    It restricts the userlist by return users having emails passed in query param
    """
        queryset = Users.objects.all()
        email = self.request.query_params.get('email', None)
        if email is not None:
            queryset = queryset.filter(email=email)
        return queryset
    

相关问题