swagger/OpenAPI注释V3-在swagger注释中使用枚举值

Question

我正在使用从以下依赖项导入的Swagger/OpenAPIV3注释创建应用程序的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;

现在，我想使用在枚举类上构造的自定义方法，该方法返回允许的字符串数组，因此不需要在每次向枚举添加类型时添加该方法。以便我们可以这样使用它：

public enum ExampleEnum {
    EXAMPLEV1, EXAMPLEV2;
    public static String[] getValues() {...}
}

@Schema(description = "example", 
        allowableValues = ExampleEnum.getValues(), 
        example = "exampleV1", required = true)
private String example;

现在这是无法编译的，因为在执行注释时不知道该方法。是否有这样的解决方案允许在SwaggerV3注释属性值中使用枚举？

查看了以下资源：

• https://swagger.io/docs/specification/data-model/enums/

您可以在global components部分中定义可重用的枚举，并在其他地方通过$ref引用它们。

最坏的情况是，我确实可以在一个常量位置定义它，并且在将类型添加到枚举之后，只需要另外一个位置来添加类型。但如果可能的话，我首先想探讨一下上面提到的解决方案。

• https://github.com/swagger-api/swagger-core/wiki/swagger-2.x---注释#schema

没有提到使用任何类或动态生成的值。

• 大摇大摆地枚举

是关于在swagger中记录枚举，而不是在swagger注释API中使用它们。

Answer 1

尝试使用@schema(implementation=exampleEnum.class,...)，您可以添加所需的所有其他属性。我需要更多的信息，您的实现，但尝试这首先。