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