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

Question

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

这是我的序列化程序的样子

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

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

Answer 1

指定help_text额外的关键字参数（见文档），而不是宣布串行领域，具体规定已经在模型领域的所有选项（unique，null，max_length等）

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

Answer 2

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

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