Question

我查看了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文档中包含序列化程序文档字符串吗？

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

django-rest-framework和swagger api文档

1 个答案: