документация django-rest-framework и документация swagger api

Question

Я посмотрел проект django-rest-swagger, и я хочу использовать его для документа api для моего проекта. Но есть некоторые вопросы о том, как это сделать.

1. Как использовать атрибут help_text для модели или сериализатора? В документации он сказал: «Свойство поля help_text используется для создания описания из сериализатора или модели». Но документация api содержит только имена полей и типы полей, и нет описания значений по умолчанию (в этом примере для цвета поля), например.

   Response Class 
   CigarSerializer { 
       name (string), 
       url (url, optional), 
       colour (string), 
       price (decimal), 
       length (integer), 
       gauge (integer), 
       notes (string), 
       id (integer, optional), 
       manufacturer (field) 
   } 
   

   Можно ли включить атрибут help_text в документацию api?

2. Могу ли я включить строку документа serializer в документацию api?

Answer 1

Вышеописанное определение вашего Serializer. Вот как вы должны определить свой Сериализатор с help_text:

class CigarSerializer(serializers.ModelSerializer): 
    url = fields.URLField(source='get_absolute_url', read_only=True, help_text="this is where you add help text") 
    ... 

    class Meta: 
     model = models.Cigar