Swagger/openapi将@Schema(description)添加到每个枚举值
Swagger/openapi将@Schema(description)添加到每个枚举值
提问于 2021-07-05 14:56:53
我使用Swagger/OpenApi V3注解创建应用程序的API描述，这些注解是从以下依赖项导入的：
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.5.0</version>
</dependency>我想将描述添加到每个枚举值：
public enum Gender {
@Schema(description = "NotSpecified")
NOT_SPECIFIED,
@Schema(description = "Male")
MALE,
@Schema(description = "Female")
FEMALE;
}但是springdoc不会为枚举生成描述。
Gender:
type: string
example: MALE
enum:
- NOT_SPECIFIED
- MALE
- FEMALE有没有办法给每个枚举值添加描述？
回答 1
Stack Overflow用户
发布于 2021-07-09 22:06:57
我相信你只能在枚举描述(https://swagger.io/docs/specification/data-models/enums/)中描述枚举值。所以你可以这样做：
@Schema(enumAsRef = true, description = "gender: \n" +
"* `NOT_SPECIFIED` - NotSpecified\n" +
"* `MALE` - Male\n" +
"* `FEMALE` - Female\n" +
"")
enum Gender {
NOT_SPECIFIED,
MALE,
FEMALE
}然后，生成的swagger看起来相当不错。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/68251827
复制相关文章
相似问题
腾讯云开发者
