小编Den*_*nis的帖子

Swagger/openapi 将 @Schema(description) 添加到每个枚举值

我正在使用 Swagger/OpenApi V3 注释创建应用程序的 API 描述,从以下依赖项导入:

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.5.0</version>
</dependency>
Run Code Online (Sandbox Code Playgroud)

我想将描述添加到每个枚举值:

public enum Gender {

    @Schema(description = "NotSpecified")
    NOT_SPECIFIED,

    @Schema(description = "Male")
    MALE,

    @Schema(description = "Female")
    FEMALE;
}
Run Code Online (Sandbox Code Playgroud)

但 springdoc 不会生成 enum 的描述。

Gender:
  type: string
  example: MALE
  enum:
  - NOT_SPECIFIED
  - MALE
  - FEMALE
Run Code Online (Sandbox Code Playgroud)

有没有办法为每个枚举值添加描述?

java swagger openapi springdoc

5
推荐指数
1
解决办法
3945
查看次数

标签 统计

java ×1

openapi ×1

springdoc ×1

swagger ×1