如何在Django休息框架中实现过滤器API [英] How to implement filter API in Django rest framework

问题描述

我试图在django休息中实现过滤器api。像 -

  localhost：8000 / api / v1 / users /？email=[e-mail]/ 
  

所以应该搜索已经通过的过滤器的用户并返回结果。但是目前它正在返回所有的用户。

URLS.py

  url（r'^ api / v1 / users / $'，UserViews.UserList.as_view（），name ='userlist_view'），
 url（r'^ api / v1 / users /（？P< email>。+）/ $' .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）：

列出所有用户，或创建一个新用户
 $
 
 
 def get（self，request，format = None）：
如果request.user.is_authenticated（）：
用户= User.objects.all（）
 serializer = UserSerializer（users，many = True）
返回响应（serializer.data）
返回响应（用户未认证，status = status.HTTP_400_BAD_REQUEST）
 
 def post（self，request，format = None）：
 
 valid_paylaod，msg = UserListRepository.validations_create_user（request.data）
如果不是valid_paylaod：
 return响应（msg，status = status.HTTP_400_BAD_REQUEST）
 
 result = UserListRepository.create_user_repo（request）
 
如果不是result.success：
返回响应（str（result.msg），状态= result.status）
 
返回响应（UserSerializer（result.data）.data，status = result.status）
 
 def get_queryset（self）：
＃它限制用户列表，通过退出用户的邮件传递在uery param 
 user = self.request.user 
如果user.is_authenticated（）：
如果emailin self.request.query_params： 
 email = self.request.query_params.get（'email'，None）
 users = User.objects.get（email = email）
如果不是用户：
返回响应（用户不发现，status = status.HTTP_404_NOT_FOUND）
 else：
返回响应（UserSerializer（User.objects.all（））。data，status.HTTP_200_OK，users）
 else：
返回响应（UserSerializer（）。data，status = result.status）
 else：
返回响应（用户未通过身份验证，status = status.HTTP_400_BAD_REQUEST）
  

有些人可以告诉为什么请求不会get_queryset（）方法，而是去get（）UserList方法。在删除get方法时，请求转到get_queryset（self）方法。在调试时，我发现在return语句之前我得到了有效的响应 -

 （Pdb）UserSerializer（result.data）.data 
 {'parent_id'：2，'id'：31，'group_id'：'4'，'last_name'：'user'，'email'：'[e-mail]'，'organization_id' 'first_name'：'agency22'} 
  

但是在APi响应中，我收到以下错误： p>

 内部服务器错误：/ api / v1 / users / 
追溯（最近呼叫最后）：
文件/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-packages/django/core/handlers/base.py，第149行，get_response 
 response = self.process_exception_by_middleware（e，request） 
文件/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-packages/django/core/handlers/base.py，第147行，get_response 
 response = wrapped_callback（请求，* callback_args，** callback_kwargs）
 Fi e/ Users / richagupta / VirtualEnvs / py35 / lib / pyt hon3.5 / site-packages / django / views / decorators / csrf.py，第58行，wrapped_view 
 return view_func（* args，** kwargs）
文件/ Users / richagupta / VirtualEnvs /py35/lib/python3.5/site-packages/django/views/generic/base.py，第68行，视图
 return self.dispatch（request，* args，** kwargs）
文件/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-packages/rest_framework/views.py，第466行，在调度中
 response = self.handle_exception（exc）
文件/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-packages/rest_framework/views.py，第463行，调度
 response = handler（request，* args，** kwargs） 
文件/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-packages/rest_framework/generics.py，第201行，get 
 return self.list（request，* args ，** kwargs）
文件/Users/richagupta/VirtualEnvs/py35/lib/python3.5/site-packages/rest_framework/mixins.py，第43行，列表
如果页面不是无：
文件/ Users / richagupta / VirtualEnvs / py35 / lib / python3 .5 / site-packages / rest_framework / serializers.py，第674行，数据
 ret = super（ListSerializer，self）.data 
文件/ Users / richagupta / VirtualEnvs / py35 / lib / python3.5 / site-packages / rest_framework / serializers.py，第239行，数据
 self._data = self.to_representation（self.instance）
文件/ Users / richagupta / VirtualEnvs / py35 /lib/python3.5/site- packages / rest_framework / serializers.py，第614行，to_representation 
 self.child.to_representation（item）for iterable 
文件/ Users / richagupta / VirtualEnvs / py35 / lib / python3.5 / site-packages / django / template / response.py，第173行，__iter__ 
 raise ContentNotRenderedError（'响应内容必须为'
 django.template。 response.ContentNotRenderedError：响应内容必须先渲染才能被迭代。 
  

我不清楚为什么。 API URL我正在打的是：localhost：8000 / api / v1 / users？email=[e-mail]

解决方案

问题在于您覆盖获取方法 ListAPIView 。此方法由GET请求调用。 get 的默认实现调用 ListModelMixin 的列表方法，而$ get_queryset 被调用：

  def list（self，request，* args，** kwargs）：
 queryset = self.filter_queryset（self.get_queryset（））
 
 page = self.paginate_queryset（queryset）
如果页面不是无：
 serializer = self.get_serializer（页面，许多= true）
 return self.get_paginated_response（serializer.data）
 
 serializer = self.get_serializer（queryset，many = True）
返回响应（serializer.data）
  

如果您重写此方法，您必须自己调用 get_queryset 。
如果您只想检查用户是否通过身份验证，然后调用默认列表方法，您可以这样执行：

  def get（self，request，format = None）：
 if request.user.is_authenticated（）：
 return super（UserList，self）.get（request，format）
返回响应（用户未通过身份验证，status = status.HTTP_400_BAD_REQUEST）
  

I am trying to implement filter api in django rest. Something like -

localhost:8000/api/v1/users/?email=[e-mail]/

So it should search for user with the passed filter and return the result.But currently it is returning all user.

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)

Can some one tell why the request is not going to get_queryset() method and going to get() of UserList method. On removing get method, the request goes to get_queryset(self) method. On debugging, I found that I get valid Response before return statement -

(Pdb) UserSerializer(result.data).data
{'parent_id': 2, 'id': 31, 'group_id': '4', 'last_name': 'user',         'email': '[e-mail]', 'organization_id': 0, 'first_name':  'agency22'}

But Still in APi response, I get following error :

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.

I am not clear why . API URL I am hitting is : localhost:8000/api/v1/users?email=[e-mail]

解决方案

The problem is that you are overriding the get method of ListAPIView. This method is called by a GET request. The default implementation of get calls the list method of ListModelMixin and there get_queryset gets called:

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)

If you override this method you have to call get_queryset yourself. If you just want to check if the user is authenticated and then call the default list method you can do it like this:

  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)

这篇关于如何在Django休息框架中实现过滤器API的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！