django-rest-framework - 将新请求示例附加到 drf-spectacular 模式

Question

我知道为 drf-spectacular 使用的模式添加示例的方法是：

examples=[
            OpenApiExample(
                'Example 1',
                description='longer description',
                value='example'
            ),
        ]

但是，我不想从头开始创建示例，而是想在自动生成的示例中添加一个新示例。

有没有办法做到这一点？或者至少，从序列化程序生成请求正文。

谢谢！

Answer 1

drf-spectacular 本身不会生成示例。除非您提供OpenApiExample实例。架构将不包含示例。如果您看到一个示例，那是因为您的 UI（swagger/redoc）基于给定类型提出了一个示例。我假设一旦你提供了一个实际的例子，他们就会停止这样做。

我认为一旦你表明你自己处理你的例子，这是有道理的。无论如何，这将是 UI 中的一个设置，因为这与壮观无关。