微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

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

如何解决Swagger编辑器如何指定请求正文POST中需要哪些字段?

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

我希望能够在请求正文中指定多个字段,并且希望生成的文档反映仅2个字段是必需的,其他是可选的。

要做到这一点,我必须做什么/更改?

我尝试使用“ required”关键字进行各种变体(请参见下图),但无法进行该工作,它不会显示生成的文档中(请参见右下图)我的注释为红色)。

这是我在编辑器中的POST定义:

enter image description here

这是生成的文档预览,在该文档中,我指出了我希望更改的内容

enter image description here

PS。还有更多(较旧的)帖子可以解决这个问题,但是我真的不认为这是重复的。

解决方法

我希望能够在请求正文中指定多个字段,并且希望生成的文档反映仅2个字段是必需的,其他是可选的。

您的第二个示例是正确的。要指定所需的对象属性,请在对象级别上添加required: [prop1,prop2,...](即,在type: object旁边)。 required列表中未列出的属性是可选的。如果未提供required列表,则所有属性都是可选的。

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

在Swagger UI中,特定于操作的架构文档显示在 Schema (或 Model )选项卡上。在此处显示属性描述,数据类型,“必需”指示符和其他架构信息。

enter image description here

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

要默认启用 Schema / Model 标签,请在Swagger UI上将defaultModelRendering选项设置为"model"

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。