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

【问题标题】：DRF APIView - How can I add help text to auto generated form?DRF APIView - 如何将帮助文本添加到自动生成的表单？
【发布时间】：2019-04-25 07:22:46
【问题描述】：

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

这就是我的序列化器的样子

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

我的表单域应该有帮助文本。我怎样才能添加它们？谢谢！

【问题讨论】：

标签： django python-3.x django-rest-framework

【解决方案1】：

将help_text 指定为附加关键字参数（请参阅documentation），而不是声明一个序列化器字段，指定模型字段中已经存在的所有选项（unique、null、max_length 等）

class MySerializer(serializers.ModelSerializer):
    class Meta:
        model = MyModel
        fields = ('id','name', ...)
        extra_kwargs = {
            'name': {
                'help_text': 'You help text here...'
            }
        }

【讨论】：

【解决方案2】：

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

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

【讨论】：

【解决方案3】：

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

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

More Info...

【讨论】：