Swagger 需要所有属性

Posted

技术标签:

【中文标题】Swagger 需要所有属性【英文标题】:Swagger require all properties 【发布时间】:2017-01-16 05:56:36 【问题描述】:

鉴于以下架构定义(这是定义所需属性的有效方式):

MySchema:
 type: object
 required: [property1, property2, property3]
 properties:
  property1:
   type: integer
  property2:
   type: integer
  property3:
   type: integer

有没有办法指定所有属性都是必需的?

澄清:我正在寻找一种方式来说明所有属性都是必需的,而不是一一指定。

更明确地说:this 没有回答我的问题。

【问题讨论】:

【参考方案1】:

这是根据需要定义模型属性的正确方法,我不知道有任何其他方法可以指定所有属性都是必需的。

对于参数,required 属性是一个布尔值 (true/false),而不是所需参数名称的列表。例如

name: avatar
in: formData
description: The avatar of the user
required: true
type: file

【讨论】:

以上是关于Swagger 需要所有属性的主要内容,如果未能解决你的问题,请参考以下文章

Swagger UI - 默认情况下如何扩展所有操作?

springBoot 整合 swagger 展示返回对象的嵌套属性文档注释

Swagger 继承与组合

Swagger笔记之Swagger注解

给swagger添加文档注释详细步骤

swagger中怎么添加apis属性