使用多个字段创建自定义 Django REST url

Question

我正在构建一个与 Django 数据库对话的 SMS API，该数据库是数百人的联系信息列表。字段如下：名字、姓氏、电话号码和职位。

当我在本地服务器上使用此 url 时收到响应：

http://localhost:8000/sources/id

我想做的是使用这个 url 向同一个数据库发出请求：

http://localhost:8000/sources/first_name-last_name

我调查了多个有关字段查找的问题，但没有任何帮助。这是我的 serializers.py 的样子：

from rest_framework import serializers, viewsets
from text_source.models import Source

class SourceSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Source
        fields = ('id','first_name','last_name','title','organization','city','cell_phone','office_phone')
        lookup_field = 'first_name'

class SourceViewSet(viewsets.ModelViewSet):
    queryset = Source.objects.all()
    serializer_class = SourceSerializer
    lookup_field = ('first_name')

我不确定使用 /first_name-last_name 作为 url 的端点是否是最佳实践，但理论上我正在做的事情，它会起作用。

理想情况下，我希望有人在文本中键入 FIRSTNAME LASTNAME，并通过将全名连接到数据库中的 ID 让 API 返回正确的信息。任何实现这一目标的技巧将不胜感激。

urls.py

from django.conf.urls import include, url
from django.contrib import admin
from django.views.generic.base import TemplateView
from django.contrib.auth.models import User

from rest_framework import routers, serializers, viewsets
from app import views
from app.serializers import SourceSerializer, SourceViewSet

router = routers.DefaultRouter()
router.register(r'sources', SourceViewSet)

urlpatterns = [

    url(r'^page/$', TemplateView.as_view(template_name='base.html')),

    url(r'^page/', include(router.urls)),

    url(r'^admin/', include(admin.site.urls)),

    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')),

    url(r'^page/incoming/message$', views.incoming_message)
]

Answer 1

我会尝试执行以下示例。您可以将 kwargs 更改为您最终使用的任何内容。

序列化器：

class SourceUrlField(serializers.HyperlinkedIdentityField):
    def get_url(self, obj, view_name, request, format):
        kwargs = {
            'first_name': obj.first_name,
            'last_name': obj.last_name
        }
        return reverse(view_name, kwargs=kwargs,
                       request=request, format=format)

class SourceSerializer(serializers.HyperlinkedModelSerializer):
    url = SourceUrlField("view_name")

    class Meta:
        model = Source
        fields = (
            'id',
            'url',
            'first_name',
            'last_name',
            'title',
            'organization',
            'city',
            'cell_phone',
            'office_phone',
        )

根据 Joey 的推理，如果可能，我会避免使用 first_name 和 last_name。但是，我刚刚向您展示的示例适用于您选择使用的任何 kwarg。

Answer 2

我认为您可能会遇到使用/sources/first_name-last_name 作为端点的问题，因为您永远无法保证名称的唯一性，并且名称也可能包含破折号。我建议将/sources/id（可能是/sources/）保留为您的端点，并且只允许过滤。

您可以阅读in the DRF documentation 了解有关过滤的更多详细信息，但一个基本示例（安装 django-filter 之后）如下所示：

from rest_framework import filters, serializers, viewsets
from text_source.models import Source

class SourceSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Source
        fields = ('id','first_name','last_name','title','organization','city','cell_phone','office_phone')


class SourceViewSet(viewsets.ModelViewSet):
    queryset = Source.objects.all()
    serializer_class = SourceSerializer
    filter_backends = (filters.DjangoFilterBackend,)
    filter_fields = ('first_name', 'last_name')

一旦你有了这个，你就可以按照/sources/?first_name=Bob&last_name=Dobbs 的行来构造 URL 来执行你的搜索并返回 ID。

另请注意，您的示例中有一个非常重要的错误。您将 ViewSet 上的lookup_field 指定为('first_name')。由于元组中只有一个元素，这种精确的语法将产生非常不希望的副作用，将字符串 'first_name' 视为可迭代，创建一个看起来像 ('f', 'i', 'r', 's', 't', '_', 'n', 'a', 'm', 'e') 的元组。为了防止这种情况，您想要使用的是('first_name', )。注意结尾的逗号。

Answer 3

您可以在运行时覆盖 lookup_field，具体取决于您在 GET 参数中获得的属性。您不能为此使用 kwargs，只要您只想定义一个视图和 url。

示例网址：-

/sources/?parameter=first_name&first_name='someone'

相应地更改您的视图集：-

class SourceViewSet(viewsets.ModelViewSet):
     queryset = Source.objects.all()
     serializer_class = SourceSerializer
     lookup_field = ('first_name')

     def initial(self, request, *args, **kwargs):
         parameter = request.data.get('parameter')
         self.lookup_field = parameter
         kwargs[parameter] = request.data.get(parameter)

         super(SourceViewSet, self).initial(request, *args, **kwargs)