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

Question

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

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

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

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

Answer 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...'
            }
        }