2

我在 API url 的基础中使用了一个变量，与Django REST Framework文档中的设置相同：

/api/<brand>/states/<state_pk>/

基本品牌 slug 之后的所有内容都是标准 API 格式，因此我使用 ModelViewSets 为我的对象生成所有列表和详细视图。API 中的所有内容都由品牌过滤，因此这种设置是有意义的。

简化项目/urls.py

urlpatterns = patterns(
    '',
    url(r'^v2/(?P<brand_slug>\w+)/', include(router.urls, namespace='v2')),
)

简化的 api/urls.py

router = routers.DefaultRouter()
router.register(r'states', StateViewSet)
router.register(r'cities', CityViewSet)

我还需要所有模型的超媒体链接，这就是我遇到问题的地方。REST 框架不知道如何获取这个品牌变量并使用它来生成正确的链接。尝试通过遵循文档来解决这个问题给我留下了两个挫折：

  1. 虽然文档解释了如何覆盖 HyperlinkRelatedField 类，但他们从未说明将那个类放在哪里以便它与我的序列化程序一起使用。
  2. 没有提及如何将品牌变量从 URL 实际获取到 HyperlinkRelatedField 类中。

这里缺少什么元素？

4

1 回答 1

2

所以，我想通了。

将 URL 变量放入序列化程序

为此，您需要覆盖您的 ModelViewSet 的 get_serializer_context() 方法，并从您的 kwargs 中发送变量

class BrandedViewSet(viewsets.ModelViewSet):
    def get_serializer_context(self):
        context = super().get_serializer_context()
        context['brand_slug'] = self.kwargs.get('brand_slug')
        return context

然后，您可以使用该类扩展所有 ModelViewSet：

class StateViewSet(BrandedViewSet):
    queryset = State.objects.all()
    serializer_class = StateSerializer

很好的是，即使您已经使用此变量注入了 Serializer，它也可以从 HyperlinkedRelatedField 类通过 via 访问self.context，这就是下一部分的可能方式。

使用额外的 URL 变量构建自定义超媒体链接

文档在覆盖方面是正确的get_url()：

class BrandedHyperlinkMixin(object):
    def get_url(self, obj, view_name, request, format):
        """ Extract brand from url
        """
        if hasattr(obj, 'pk') and obj.pk is None:
            return None

        lookup_value = getattr(obj, self.lookup_field)
        kwargs = {self.lookup_url_kwarg: lookup_value}
        kwargs['brand_slug'] = self.context['brand_slug']
        return reverse(
            view_name, kwargs=kwargs, request=request, format=format)

除了，您会注意到我从第 1 部分中设置的上下文中获取变量。我无法按照文档的建议从对象中获取上下文，结果证明这种方法更简单。

它是一个 mixin 的原因是因为我们需要扩展两个类以使其适用于所有url超链接，而不仅仅是相关的字段超链接。

class BrandedHyperlinkedIdentityField(BrandedHyperlinkMixin,
                                      serializers.HyperlinkedIdentityField):
    pass


class BrandedHyperlinkedRelatedField(BrandedHyperlinkMixin,
                                     serializers.HyperlinkedRelatedField):
    pass


class BrandedSerializer(serializers.HyperlinkedModelSerializer):
    serializer_related_field = BrandedHyperlinkedRelatedField
    serializer_url_field = BrandedHyperlinkedIdentityField

现在我们可以安全地扩展我们的序列化程序并且超链接显示品牌变量！

class StateSerializer(BrandedSerializer):
    class Meta:
        model = State
        fields = ('url', 'slug', 'name', 'abbrev', )
于 2015-10-20T18:58:44.870 回答