[英]How to implement filter API in Django rest framework
I am trying to implement filter api in django rest. 我正在尝试在Django rest中实现filter api。 Something like - 就像是 -
localhost:8000/api/v1/users/?email=abc.xzy@gmail.com/
So it should search for user with the passed filter and return the result.But currently it is returning all user. 因此它应该使用传递的过滤器搜索用户并返回结果。但是当前它正在返回所有用户。
URLS.py 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 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. 有人可以说出为什么请求不转到get_queryset()方法而转到UserList方法的get()的原因。 On removing get method, the request goes to get_queryset(self) method. 在删除get方法时,请求将转到get_queryset(self)方法。 On debugging, I found that I get valid Response before return statement - 在调试时,我发现我在return语句之前得到了有效的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'}
But Still in APi response, I get following error : 但是仍然在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.
I am not clear why . 我不清楚为什么。 API URL I am hitting is : localhost:8000/api/v1/users?email=agency22_user@agency22.com 我输入的API URL是:localhost:8000 / api / v1 / users?email=agency22_user@agency22.com
The problem is that you are overriding the get
method of ListAPIView
. 问题是您要重写ListAPIView
的get
方法。 This method is called by a GET request. GET请求调用此方法。 The default implementation of get
calls the list method of ListModelMixin
and there get_queryset
gets called: 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)
If you override this method you have to call get_queryset
yourself. 如果重写此方法,则必须自己调用get_queryset
。 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)
I'm confused by the UrlConf: 我对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/
Second one is for localhost:8000/api/v1/users/abc.xzy@gmail.com/
not localhost:8000/api/v1/users/?email=abc.xzy@gmail.com/
, this is a query parameter not kwargs, check this if you want to use query parameter 第二个是localhost:8000/api/v1/users/abc.xzy@gmail.com/
而不是localhost:8000/api/v1/users/?email=abc.xzy@gmail.com/
,这是一个查询参数不是虚假的,请检查是否要使用查询参数
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
In Django rest framework there is a proper specification of how to use filters. 在Django rest框架中,有关于如何使用过滤器的适当规范。 So your user class would look like. 因此您的用户类看起来像。
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)
or you can try without get_queryset . 或者您可以尝试不使用get_queryset。 The link would change , updated link is : 链接将更改,更新的链接为:
localhost:8000/api/v1/users/abc.xzy@gmail.com/
and the updated code is 并且更新的代码是
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)
It looks like you are using Response
from django instead of django-rest-framework. 看来您使用的是来自django的Response
,而不是django-rest-framework。
You have to import Response from rest_framework.response 您必须从rest_framework.response导入Response
from rest_framework.response import Response
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.