Question

我正在使用Django Rest Framework，并使用APIView和序列化器形式添加新数据。我想在表单中添加一些帮助文本作为工具提示。由于表单是自动生成的，因此我需要一些有关如何将其添加到表单的帮助。我正在使用ModelSerializer。

这是我的序列化器的样子

class MySerializer(serializers.ModelSerializer):
    class Meta:
        Model = MyModel
        fields = ('id','name', ...)

我的表单字段应包含帮助文本。如何添加它们？谢谢！

Answer 1

您可以使用序列化器字段的help_text参数添加帮助文本

class MySerializer(serializers.ModelSerializer):
    name = serializers.CharField(help_text="foo bar")
    class Meta:
        Model = MyModel
        fields = ('id','name', ...)

Answer 2

您可以在models.py中添加help_text属性

name = models.CharField(max_length=60, help_text="Your help text here....")

More Info...

Answer 3

将help_text指定为附加关键字参数（请参见documentation），而不是声明一个序列化程序字段，该字段指定模型字段（unique，null，{ {1}}等）

max_length

DRF APIView-如何将帮助文本添加到自动生成的表单中？

3 个答案: