Swagger/OpenAPI批注V3-在swagger批注中使用枚举值
我正在使用Swagger/OpenApi V3批注创建应用程序的API描述,这些批注是从以下依赖项导入的:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.1.45</version>
</dependency>
其中一个批注是@Schema
批注,它接受名为allowableValues
的属性,该属性允许字符串数组:
@Schema(description = "example",
allowableValues = {"exampleV1", "exampleV2"},
example = "exampleV1", required = true)
private String example;
现在,我想使用在Enum类上构造的自定义方法,该方法返回允许的字符串数组,因此不需要在每次向Enum添加类型时添加它。这样我们就可以这样使用它:
public enum ExampleEnum {
EXAMPLEV1, EXAMPLEV2;
public static String[] getValues() {...}
}
@Schema(description = "example",
allowableValues = ExampleEnum.getValues(),
example = "exampleV1", required = true)
private String example;
现在无法编译,因为在执行注释时该方法是未知的。 是否有这样的解决方案允许在swagger V3批注属性值中使用枚举?
查看以下资源:
- https://swagger.io/docs/specification/data-models/enums/
最坏的情况是,我确实可以在一个常量位置定义它,并且在将类型添加到Enum之后,只需要将该类型添加到另一个位置。但如果可能的话,我首先想探讨一下上面提到的解决方案。您可以在全局组件部分定义可重复使用的枚举,并在其他地方通过$ref引用它们。
- https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Annotations#schema
未说明有关使用任何类或动态生成值的任何内容。
- Enum in swagger
是关于在swagger中记录枚举,而不是在swagger批注API中使用它们。
解决方案
尝试使用@Schema(implementation = ExampleEnum.class, ...)
,您可以添加所需的所有其他属性。我需要有关您的实施的更多信息,但请先尝试此操作。
相关文章