在 Django REST 框架中更新/放置请求

Question

我是 Django REST 框架的新手，我正在为我正在从事的一个新项目尝试它。因此，根据官方教程，我尝试创建几个 get/post/put 请求，但使用 put 请求时出现以下错误：

预期视图 ExampleUpdateView 将使用名为“pk”的 URL 关键字参数调用。修正您的 URL 配置，或正确设置视图上的 .lookup_field 属性。

这是我需要的文件：

models.py

class ExampleModel(models.Model):
    foo_field = models.CharField(primary_key=True, max_length=15)
    bar_field = models.CharField(max_length=30)
    last_updated_by = models.CharField(max_length=15)
    last_updated_on = models.DateTimeField()

    class Meta:
        managed = True
        db_table = 'example_db'
        unique_together = (('foo_field', 'bar_field'),)

serializers.py

class ExampleSerializer(serializers.ModelSerializer):
    class Meta:
        model = ExampleModel
        fields = ('foo_field', 'bar_field', 'last_updated_by', 'last_updated_on')

urls.py

url(r'^get_example/$', views.ExampleCreateView.as_view()),
url(r'^update_example/(?P<pk>\d+)/$',views.ExampleUpdateView.as_view()),

views.py

class ExampleCreateView(generics.CreateAPIView):
    serializer_class = ExampleSerializer
    queryset = ExampleModel.objects.all()

class ExampleUpdateView(generics.UpdateAPIView):
    queryset = ExampleModel.objects.all()
    serializer_class = ExampleSerializer

我认为我可能遇到的问题是我有一个复合键。我尝试了其他通用视图（CreateAPIView 和 ListAPIView），它们工作得非常好。我需要更新def_update 方法吗？我需要更改serializers.py 中的任何内容吗？

这是我从 GET 请求中获得并尝试更新的现有 JSON 对象：

{
    "foo_field": "john",
    "bar_field": "doe",
    "last_updated_by": "batman",
    "last_updated_on": "2017-02-09"
}

我查看了以下重复项，但这些解决方案似乎都不适合我：

Django Rest Framework: Unclear error message

Django REST Updateview with PUT POST

How do I use an UpdateView to update a Django Model?

Answer 1

首先，我将重构您的代码并展示代码示例。之后我会解释这些变化。

models.py

class ExampleModel(models.Model):
    foo_field = models.CharField(primary_key=True, max_length=15)
    # rest ...

您已将foo_field 设置为主键。使用字符串 (VARCHAR) 作为主键是一种不好的做法。强烈建议使用surrogate keys。这将由 Django 自动完成。它添加了一个字段id 作为主键。

serializers.py 现在可以正常工作了。无需更改。 views.py 也应该无需更改即可工作。不过，我将介绍以 foo_field 作为主键的选项。

views.py

类 ExampleUpdateView(generics.UpdateAPIView):
    ＃ 休息 ...
    查找字段 = `foo_field`

您也可以将其省略，但重要的是对您的 urls.py 进行一些更改。

urls.py

url(r'^examples/$', views.ExampleCreateView.as_view()),
url(r'^示例/(?P\d+)/$',views.ExampleUpdateView.as_view()),

为了使 Web 服务成为 RESTful，它们必须遵守 REST 原则。最重要的规则之一是我们不应该在 URL 中使用动词来描述动作。另一种约定是资源名称以复数形式用于描述集合，而标识符用于访问单个资源。

您的资源名为 example，因此我们使用 examples 作为集合名称。像 get 或 update 这样的动词在 URL 中没有位置。 HTTP 方法负责正确的操作。

如果您想使用foo_field 作为主键，那么您必须更改更新视图的 url：

url(r'^examples/(?P&lt;pk&gt;<b>[\w-]+</b>)/$',views.ExampleUpdateView.as_view()),

这是因为您的 foo_field 是 CharField（或字符串），因此传递给它的参数应匹配任何字母数字字符 (\w) 和连字符 (-)。
如果您愿意，您可以在 url 正则表达式中使用 foo_field 作为命名组，而不是 pk。请注意在您的视图中调整它，为lookup_field 和lookup_url_kwarg 设置正确的值。

我再次强烈建议使用代理键，让 Django 来完成这项任务。

现在您可以理解为什么 ListAPIView 和 CreateAPIView 会起作用了。它们不需要传递给 url 的参数并且被正确调用。
您的 UpdateAPIView 无法工作，因为匹配的 url 只接受数字并且与您的主键 foo_field 不匹配。

Answer 2

将update() 与UpdateAPIView 一起使用。

class ExampleUpdateView(generics.UpdateAPIView):
        queryset = ExampleModel.objects.all()
        serializer_class = ExampleSerializer

        def update(self, request, *args, **kwargs):
            instance = self.get_object()
            instance.foo_field = request.data.get("foo_field")
            instance.bar_field = request.data.get("bar_field")
            instance.last_updated_by = request.data.get("last_updated_by")
            instance.last_updated_on = request.data.get("last_updated_on")
            instance.save()
            serializer = self.get_serializer(instance)
            serializer.is_valid(raise_exception=True)
            self.perform_update(serializer)
            return Response(serializer.data)