使用 python Flask-Restful+apispec+marshmallow 时如何设置字段示例值？

Question

我正在使用 Flask 创建一个 Web 应用程序。我想用 swagger 生成一个 API 参考文档。 库：Flask-Restful、apispec、marshmallow（也许还有 webargs）

我能够生成符合我大部分要求的 swagger 页面，但我不知道如何为字段设置示例。已阅读这些库的官方文档，但没有找到在哪里设置字段的示例值。

预期结果：

我的结果：（无示例值）

我的代码：

# request_schema.py
from marshmallow import Schema, fields

class RequestSchema(Schema):
    name = fields.Str(required=True)      # want to set an example value here

# app.py
from flask_apispec import use_kwargs
from flask_apispec.views import MethodResource

from request_schema import RequestSchema
from flask_restful import Resource

class Restful_Request(MethodResource, Resource):
    @use_kwargs(RequestSchema(many=True), location='json')
    def post(self, *args, **kwargs):
        pass

Answer 1

将其传递到字段元数据中。

class RequestSchema(Schema):
    name = fields.Str(required=True, metadata={"example": "Whatever"})