使用 django rest 框架按名称返回信息

Question

我正在使用 Django rest 框架，我创建了这个类来返回项目的所有名称

class cpuProjectsViewSet(viewsets.ViewSet):
  serializer_class = serializers.cpuProjectsSerializer

  def list(self, request):
    all_rows = connect_database()
    name_project = [] 
    all_projects = []
    for item_row in all_rows:
      name_project.append(item_row['project'])
      name_project = list(sorted(set(name_project)))
    for i in range(0, len(name_project)):
      all_projects.append({'project' : str(name_project[i])})

    serializer = serializers.cpuProjectsSerializer(instance=all_projects, many=True)
    return Response(serializer.data)

我的 URL 是这样的 http://127.0.0.1:8000/cpuProjects/ 这个返回所有项目，购买 如果现在我想要一个特定的项目，我是否要创建一个新类？如果我想使用相同的 URL ...例如 http://127.0.0.1:8000/cpuProjects/ => 返回所有项目 http://127.0.0.1:8000/cpuProjects/nameProject => 返回一个特定的项目。

class cpuProjectsViewSet(viewsets.ViewSet):
  serializer_class = serializers.cpuProjectsSerializer
  lookup_field = 'project_name'

  def retrieve(self, request, project_name=None):
    try:
      opc = {'name_proj' : project_name }
      all_rows = connect_database(opc)
    except KeyError:
        return Response(status=status.HTTP_404_NOT_FOUND)
    except ValueError:
        return Response(status=status.HTTP_400_BAD_REQUEST)
    serializer = serializers.cpuProjectsSerializer(instance=all_rows, many=True)
    return Response(serializer.data)

可以在同一个班级做吗？我尝试使用检索方法，但需要项目的 ID，没有名称对吗？

提前致谢！

Answer 1

除非绝对需要，否则不会使用原始查询，即使那样，也不需要手动连接到数据库，因为您可以轻松访问连接对象。总体而言，您的检索方法可以改进如下：

def retrieve(self, request, pk=None):
    queryset = CpuProject.objects.all()
    cpu = get_object_or_404(queryset, pk=pk)
    serializer = serializers.cpuProjectsSerializer(cpu)
    return Response(serializer.data)

更短更容易阅读。但是，如果您使用 ModelViewset，即使这也不是真正需要的！然后默认的检索方法将为您处理这个问题。所以你的视图集减少到

class cpuProjectsViewset(viewsets.ModelViewSet):
    serializer_class =serializer = serializers.cpuProjectsSerializer
    queryset = CpuProject.objects.all()

这里不需要retrieve方法！！

但我看到您正在尝试通过名称检索特定的 CpuProject 项目（而不是使用它的 PK）。为此，您需要添加一条路线

from rest_framework.decorators import detail_route, list_route
@detail_route(url_path='(?P<slug>[\w-]+)')
def get_by_name(self, request, pk=None,slug=None):

    queryset = CpuProject.objects.all()
    cpu = get_object_or_404(queryset, name=slug)
    serializer = serializers.cpuProjectsSerializer(cpu)
    return Response(serializer.data)

Answer 2

您需要在视图类中添加lookup_field。假设你想通过用户名获取用户，你需要添加lookup_field = 'username'。

例子：

from django.contrib.auth.models import User
from django.shortcuts import get_object_or_404
from myapps.serializers import UserSerializer
from rest_framework import viewsets
from rest_framework.response import Response

class UserViewSet(viewsets.ViewSet):

    lookup_field = 'username'

    def list(self, request):
        queryset = User.objects.all()
        serializer = UserSerializer(queryset, many=True)
        return Response(serializer.data)

    def retrieve(self, request, username=None):
        queryset = User.objects.all()
        user = get_object_or_404(queryset, username=username)
        serializer = UserSerializer(user)
        return Response(serializer.data)

现在您的网址将是

url(r'^users/$', UserViewSet.as_view({'get': 'list'})),
url(r'^users/(?P<username>[a-zA-Z0-9]+)$', UserViewSet.as_view({'get': 'retrieve'})),

现在http://127.0.0.1:8000/users/ 将返回所有用户，http://127.0.0.1:8000/users/username 将返回特定用户详细信息。

您可以通过Django REST framework了解更多关于lookup_field的信息。

Answer 3

如果你想使用同一个类，你可以使用一个视图集并定义一个 list() 和 retrieve() 方法

检查http://www.django-rest-framework.org/api-guide/viewsets/第一个例子就是这样做

from django.contrib.auth.models import User
from django.shortcuts import get_object_or_404
from myapps.serializers import UserSerializer
from rest_framework import viewsets
from rest_framework.response import Response

class UserViewSet(viewsets.ViewSet):
    """
    A simple ViewSet for listing or retrieving users.
    """
    def list(self, request):
        queryset = User.objects.all()
        serializer = UserSerializer(queryset, many=True)
        return Response(serializer.data)

    def retrieve(self, request, pk=None):
        queryset = User.objects.all()
        user = get_object_or_404(queryset, pk=pk)
        serializer = UserSerializer(user)
        return Response(serializer.data)