使用Django REST Framework ModelViewSet实现PATCH更新遇pk参数错误

1. PATCH 修改数据的思路完全正确 #

REST规范中，PATCH方法就是用于部分更新资源，和PUT（全量更新）对应，你的思路符合标准REST设计，完全没问题。

2. 错误原因及解决方法 #

报错Expected view ProjectViewSet to be called with a URL keyword argument named "pk"，核心问题是视图无法通过URL获取到资源的主键（pk），或者视图配置的主键字段不匹配，具体解决步骤如下：

（1）检查URL配置 #

ModelViewSet的partial_update（对应PATCH请求）是详情视图，必须通过URL传入资源主键才能定位到要更新的对象：

• 如果你用DRF的DefaultRouter自动生成路由，只需正常注册视图集即可，它会自动生成带pk的详情路由：

  from rest_framework.routers import DefaultRouter
  from .views import ProjectViewSet
  
  router = DefaultRouter()
  router.register(r'projects', ProjectViewSet)
  urlpatterns = router.urls
  

  这样会生成/projects/<pk>/的路由，原生支持PATCH请求。
• 如果手动配置URL，必须在path中包含主键参数，同时指定视图的patch动作对应partial_update方法：

  from django.urls import path
  from .views import ProjectViewSet
  
  urlpatterns = [
      path('projects/', ProjectViewSet.as_view({'get': 'list', 'post': 'create'})),
      # 必须包含<pk>参数，这里用int:pk表示主键是整数类型
      path('projects/<int:pk>/', ProjectViewSet.as_view({'get': 'retrieve', 'patch': 'partial_update', 'put': 'update', 'delete': 'destroy'})),
  ]
  

（2）确认视图的lookup_field配置 #

如果你的模型主键不是默认的pk（比如用slug或自定义主键字段），需要在视图集中显式设置lookup_field，同时URL中的参数名要和它一致：

class ProjectViewSet(viewsets.ModelViewSet):
    queryset = Project.objects.all()
    serializer_class = ProjectSerializer
    # 比如模型用slug作为主键，这里就要设置lookup_field
    lookup_field = 'slug'

对应的URL要改成：

path('projects/<slug:slug>/', ProjectViewSet.as_view({'patch': 'partial_update'})),

（3）自定义PATCH方法的注意事项 #

其实ModelViewSet已经自带了partial_update方法，满足大部分部分更新需求，不需要手动自定义。如果确实需要自定义业务逻辑，要确保在方法中通过self.get_object()获取目标对象（该方法会自动通过URL传入的pk查找对象）：

def partial_update(self, request, *args, **kwargs):
    # 自动通过pk获取要更新的实例
    instance = self.get_object()
    # partial=True表示允许部分字段更新
    serializer = self.get_serializer(instance, data=request.data, partial=True)
    serializer.is_valid(raise_exception=True)
    # 执行更新
    self.perform_update(serializer)
    return Response(serializer.data)

3. 快速验证步骤 #

1. 启动服务后，访问DRF UI，进入某个Project的详情页面（URL需包含pk）
2. 在页面底部选择PATCH方法，填写要更新的字段数据，提交请求即可

内容的提问来源于stack exchange，提问作者whitebear