向 Marshmallow 中的字段添加描述

Question

如何在 Marshmallow 中添加字段评论或描述？

我想用 Apispec 之类的东西来展示它。

Answer 1

这是 APISpec 的 Marshmallow 扩展的现有但未记录的功能。如果您的 Marhshmallow 字段具有 this list 中的任何属性，APISpec 将在生成的 Swagger 规范中使用它。例如，我将其作为我的模式定义之一：

class ErrorSchema(Schema):
    code = fields.Int(description="An API specific Error code", required=True)
    message = fields.String(description="A user readable message")

这导致 APISpec 生成以下内容：

ErrorSchema {
message (string, optional): A user readable message,
code (integer): An API specific Error code
}

向 Marshmallow 中的字段添加描述

Add a description to a field in Marshmallow

marshmallow