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) } 

   我可以在api文檔中包含help_text屬性嗎？

2. 我可以在api文檔中包含序列化器文檔字符串嗎？

Answer 1

上面的Serializer定義不正確。 以下是使用help_text定義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