DRF APIView - Как добавить текст справки в автоматически сгенерированную форму?

Question

Я работаю с Django Rest Framework и использую APIView и форму сериализатора для добавления новых данных.Я хочу добавить текст справки в форму в качестве всплывающей подсказки.Поскольку форма генерируется автоматически, мне нужна помощь, как я могу добавить это в форму.Я использую ModelSerializer.

Вот так выглядит мой сериализатор

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

В моих полях формы должны быть тексты справки.Как я могу добавить их?Спасибо!

Answer 1

Вы можете добавить атрибут help_text в models.py

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

Подробнее ...

Answer 2

Укажите 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 3

Вы можете добавить текст справки, используя help_text аргумент поля сериализатора

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