隐藏示例值中的字段，但不在Swagger UI中的请求正文模型中隐藏

Question

我们正在尝试在Body部分的Swagger UI上实现一个场景。在“请求”部分中，我们是否可以使用隐藏一个或多个字段的示例值JSON，但模型仍会显示这些字段？

我们基本上是在尝试减少请求体中的字段数，但是模型中的所有字段都可见。

例如，我们想隐藏此处示例中的name：

但仍然在模型中显示name：

Answer 1

要在Swagger UI中隐藏自动生成的模型示例中的字段，您需要为该模型添加自定义example，其中仅包含您需要的字段。

definitions:
  Pet:
    type: object
    properties:
      ...

    # Override model example that will be displayed in Swagger UI
    example:
      id: foo
      status: available