django-rest-framework 和 swagger api 文档答案

【问题标题】：django-rest-framework and swagger api documentationdjango-rest-framework 和 swagger api 文档
【发布时间】：2014-06-05 04:47:24
【问题描述】：

我查看了django-rest-swagger 项目，我想用它来为我的项目记录 api。但是如何做到这一点存在一些问题。

如何在模型或序列化程序上使用 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 属性吗？
我可以在 api 文档中包含序列化器文档字符串吗？

【问题讨论】：

看源码，我觉得这是不可能的

标签： django django-rest-framework swagger

【解决方案1】：

您上面的序列化程序定义不正确。以下是您应该如何使用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

【讨论】：