Savagger编辑器如何指定请求正文(POST)中的哪些字段是必需的？ [英] Swagger editor how to specify which fields in request body (POST) are required?

问题描述

我正在尝试在联机Swagger编辑器中的User类上定义POST方法。

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

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

我尝试了使用"；Required&Quot；关键字的各种变体(参见下图中的一个)，但无法实现，它不会显示在生成的文档中(参见右下方带有红色注释的图片)。

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

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

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选项卡处于活动状态，请配置Swagger UI，并将defaultModelRendering选项设置为"model"。

这篇关于Savagger编辑器如何指定请求正文(POST)中的哪些字段是必需的？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！