SpringFox Swagger - 模型中的可选字段和必填字段
2022-09-03 18:13:38
我使用SpringFox库来获取我的Spring Boot应用程序的休息文档。当我单击模型时,所有元素都作为可选元素返回。有没有办法将必需的元素显示为必需元素?是否需要添加任何其他配置?
我使用SpringFox库来获取我的Spring Boot应用程序的休息文档。当我单击模型时,所有元素都作为可选元素返回。有没有办法将必需的元素显示为必需元素?是否需要添加任何其他配置?
是,默认情况下,所有字段都是可选的。要根据需要标记字段,可以使用以下批注。
@ApiModelProperty(required = true)
在应该需要的字段的 getter 方法上。这不会将该字段显示为“必填”。但是,在文档中,此字段的可选标记将被删除。
希望这有帮助。
添加了对Bean验证注释的支持,特别是在Springfox v2.3.2中对@NotNull,@Min,@Max和@Size。
您可以将这些注释放在任何 API 模型上。
为了使用它,添加了springfox-bean-validators依赖关系:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-bean-validators</artifactId>
</dependency>
添加到应用程序的配置类:
@Import({springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration.class})
请参见: https://springfox.github.io/springfox/docs/current/#springfox-support-for-jsr-303