Django Rest Framework – 序列化程序中的自定义超链接字段

Question

如何在序列化程序中添加自定义超链接字段？我想在我的序列化程序中有一个超链接字段，其中包含查询参数。据我所知，由于无法从HyperlinkedRelatedField 或HyperlinkedIdentityField 传递查询参数，因此我尝试使用SerializerMethodField。但是，这只会序列化为字符串，当我通过浏览器访问 API 时，它不是可点击的 URL。我的代码如下所示：

class MySerializer(serializers.HyperlinkedModelSerializer):
    custom_field = serializers.SerializerMethodField()

    class Meta:
        model = MyModel
        fields = ('url', 'custom_field')

    def get_custom_field(self, obj):
        result = '{}?{}'.format(
            reverse('my-view'),
            urllib.urlencode({'param': 'foo'})
        )
        return result

另外，我无法理解 HyperlinkedRelatedField 和 HyperlinkedIdentityField 之间的区别，因此我们将不胜感激。

Answer 1

这应该可以解决问题：

from rest_framework.reverse import reverse

class MySerializer(serializers.HyperlinkedModelSerializer):
    custom_field = serializers.SerializerMethodField()

    class Meta:
        model = MyModel
        fields = ('url', 'custom_field')

    def get_custom_field(self, obj):
        result = '{}?{}'.format(
            reverse('my-view', args=[obj.id], request=self.context['request']),
            'param=foo'
        )
        return result

rest_framework 中的 reverse 函数接受一个视图名称（您想链接到的任何视图）、一个 args 列表（在本例中为对象 id）或 kwargs，以及一个请求对象（可以在内部访问self.context['request'] 的序列化程序）。它还可以采用格式参数和您想要传递给它的任何额外参数（作为字典）。

然后，反向函数会为您构建一个漂亮的、格式完整的 URL。您可以通过简单地将尽可能多的?{}&{}&{} 添加到结果变量中来添加查询参数，然后使用您想要的任何其他参数填写format 函数内的“param = foo”下方的一系列查询参数。

HyperlinkedIdentityField 用于正在序列化的对象本身。因此，HyperlinkedIdentifyField 被用来代替 MyModel 上的主键字段，因为您使用的是 HyperlinkedModelSerializer，它为正在序列化的对象本身的 pk 创建了一个 HyperlinkedIdentityField。

HyperlinkedRelatedField 用于定义与相关对象的超链接关系。因此，如果有一个 MySecondModel 与 MyModel 具有外键关系，并且您希望在您的 MyModel 序列化程序上具有指向所有相关 MySecondModel 对象的超链接，您将使用 HyperlinkedRelatedField 像这样（记住将新字段添加到 Meta 中的 fields 属性）：

class MySerializer(serializers.HyperlinkedModelSerializer):
    custom_field = serializers.SerializerMethodField()
    mysecondmodels = serializers.HyperlinkedRelatedField(
        many=True
        read_only=True,
        view_name='mysecondmodel-detail'
    )

    class Meta:
        model = MyModel
        fields = ('url', 'custom_field', 'mysecondmodels')

    def get_custom_field(self, obj):
        result = '{}?{}'.format(
            reverse('my-view', args=[obj.id], request=self.context['request']),
            'param=foo'
        )
        return result

如果它是 OneToOneField 而不是 MySecondModel 上的 ForeignKey 字段，那么您将设置 many=False。

希望这会有所帮助！