Django REST使用HyperlinkedModelSerializer报URL解析错误如何解决

ImproperlyConfigured at /watch/stream/
无法使用视图名"streamplatform-detail"解析超链接关系的URL。您可能未在API中包含相关模型，或是该字段的lookup_field属性配置错误。

该报错由以下几个问题共同导致：

1. 视图名不匹配：HyperlinkedModelSerializer生成模型实例详情超链接时，默认遵循{模型小写名称}-detail的视图命名规则，你的StreamPlatform模型对应默认需要名为streamplatform-detail的路由，但你在urls.py中给Stream详情接口配置的路由名是stream-details，名称不匹配导致URL解析失败。
2. 序列化上下文缺失：StreamDetailAV类的get、put方法中，实例化StreamPlatformSerializer时没有传入context={'request': request}参数，超链接序列化依赖request对象生成完整URL，缺少该参数也会导致解析异常。
3. 视图逻辑错误：StreamDetailAV的delete方法错误查询了WatchList模型，会导致删除StreamPlatform实例时触发数据不存在或删错数据的问题。

步骤1：修正路由命名（二选一即可） #

方案A：修改路由名匹配默认规则 #

修改urls.py中Stream详情路由的name属性：

# urls.py 原代码
path('stream/<int:pk>/', StreamDetailAV.as_view(), name='stream-details'),
# 替换为
path('stream/<int:pk>/', StreamDetailAV.as_view(), name='streamplatform-detail'),

方案B：序列化器指定自定义视图名 #

如果你不想修改现有路由名，可在StreamPlatformSerializer中显式指定url字段对应的视图名：

# serializer.py 修改后代码
class StreamPlatformSerializer(serializers.HyperlinkedModelSerializer):
    watchlist = WatchListSerializer(many=True, read_only=True)
    class Meta:
        model = StreamPlatform
        fields = "__all__"
        extra_kwargs = {
            'url': {'view_name': 'stream-details', 'lookup_field': 'pk'}
        }

步骤2：补全序列化上下文 #

修改StreamDetailAV类中的序列化代码，传入request上下文：

# get方法
serializer = StreamPlatformSerializer(platform, context={'request': request})
# put方法
serializer = StreamPlatformSerializer(platform, data=request.data, context={'request': request})

步骤3：修复删除逻辑的查询错误 #

修改StreamDetailAV的delete方法：

def delete(self, request, pk):
    # 原错误代码：platform = WatchList.objects.get(pk=pk)
    platform = StreamPlatform.objects.get(pk=pk)
    platform.delete()
    return Response(status=status.HTTP_204_NO_CONTENT)

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