使用DRF ViewSets时，自动生成的vehicle-detail路由无法解析求助

使用Django Rest Framework的HyperlinkedModelSerializer、ViewSets和Router时，生成的路由中明明存在vehicle-detail，但访问/api/vehicles/时出现以下错误：

ImproperlyConfigured at /api/vehicles/
Could not resolve URL for hyperlinked relationship using view name "vehicle-detail". You may have failed to include the related model in your API, or incorrectly configured the `lookup_field` attribute on this field.

移除序列化器fields中的url字段后API可正常运行，请问哪里配置缺失？

相关代码 #

urls.py

from rest_framework.routers import DefaultRouter
from vehicles import viewsets

# 创建路由器并注册ViewSets
router = DefaultRouter()
router.register(r'vehicles',
                viewsets.VehicleViewSet,
                basename='vehicle')

# API路由由路由器自动生成
urlpatterns = [
    path('', include(router.urls)),
]

vehicles/viewsets.py

class VehicleViewSet(viewsets.ModelViewSet):
    queryset = Vehicle.objects.all()
    serializer_class = VehicleSerializer

vehicles/serializers.py

class VehicleSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Vehicle
        fields = ['url', 'name', 'description']
        # fields = ['name', 'description']  # 移除url字段后API正常运行

生成的URL路由 #

api/ ^vehicles/$ [name='vehicle-list']
api/ ^vehicles\.(?P<format>[a-z0-9]+)/?$ [name='vehicle-list']
api/ ^vehicles/(?P<pk>[^/.]+)/$ [name='vehicle-detail']
api/ ^vehicles/(?P<pk>[^/.]+)\.(?P<format>[a-z0-9]+)/?$ [name='vehicle-detail']
api/ [name='api-root']
api/ <drf_format_suffix:format> [name='api-root']

环境版本 #

Django                  5.1
djangorestframework     3.15.2

这个问题的核心是HyperlinkedModelSerializer生成url字段时，需要序列化器获取当前请求对象（request）来构建完整URL，默认情况下如果ViewSet没有将request传入序列化器上下文，就会触发路由解析错误。

以下是两种可行的解决方式：

方式一：在ViewSet中传递request上下文 #

修改VehicleViewSet，重写get_serializer_context方法，确保request被传入序列化器：

class VehicleViewSet(viewsets.ModelViewSet):
    queryset = Vehicle.objects.all()
    serializer_class = VehicleSerializer

    def get_serializer_context(self):
        context = super().get_serializer_context()
        context['request'] = self.request
        return context

方式二：显式指定HyperlinkedIdentityField（备选方案） #

如果不想修改ViewSet，也可以在序列化器中手动定义url字段，明确指定对应的view名称和lookup字段：

class VehicleSerializer(serializers.HyperlinkedModelSerializer):
    url = serializers.HyperlinkedIdentityField(
        view_name='vehicle-detail',
        lookup_field='pk'
    )
    
    class Meta:
        model = Vehicle
        fields = ['url', 'name', 'description']

原理说明 #

HyperlinkedModelSerializer的url字段依赖request对象生成完整的绝对URL，同时需要匹配路由中定义的view_name（此处为vehicle-detail）。当序列化器无法获取request时，无法构建有效URL，就会抛出路由解析失败的错误。通过确保request传入序列化器上下文，即可解决该问题。

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