Swagger编辑器如何指定请求正文（POST）中需要哪些字段？

Question

我正在尝试在在线Swagger编辑器中的用户类上定义POST方法。

我希望能够在请求正文中指定多个字段，并且我希望生成的文档能够反映出只需要两个字段，其他字段是可选的。

我必须做什么/改变才能做到这一点？

我已经尝试过使用“required”关键字的各种变体（见下图），但没有成功，它没有显示在生成的文档中（见下图右侧，我的注释为红色）。

以下是我在编辑器中的帖子定义：

这里是生成的文档预览，我已经指出了我希望看到更改的内容。

另外，还有一些（老）帖子提到了这一点，但我真的不认为这是一个重复。

Answer 1

我希望能够在请求正文中指定多个字段，并且我希望生成的文档能够反映出只需要两个字段，其他字段是可选的。

您的第二个示例是正确的。要指定所需的对象属性，请在对象级别添加必需：[prop1， prop2，...]（即在type： ject旁边）。必需列表中未列出的属性是可选的。如果未提供必需列表，则所有属性都是可选的。

type: object
required: [email, password]  # <--------
properties:
  email:
    type: string
  password:
    type: string
  name:
    type: string

在Swagger UI中，特定于操作的模式文档显示在模式（或模型）选项卡上。在那里显示属性描述、数据类型、“必需”指示器和其他模式信息。

现在我必须弄清楚如何将“模式”显示为默认值

要使Schema/Model选项卡在默认情况下处于活动状态，请将Swagger UI配置为defaultModelRending选项设置为"model"。