如何在Swagger中显式指定枚举值的描述?
时间: 2024-10-12 17:11:10 浏览: 28
在Swagger中显式指定枚举值的描述,通常通过使用`@ApiModelProperty`注解来完成,特别是在Springfox(Spring Boot集成Swagger的库)中。对于每个枚举值,你可以为其提供一个详细的描述、显示名称以及位置(如果按照数组排序的话)。例如:
```java
public enum Color {
RED("@color.red", "红色"),
GREEN("@color.green", "绿色");
private String code;
private String description;
Color(String code, String description) {
this.code = code;
this.description = description;
}
@ApiModelProperty(
value = "颜色描述",
notes = "这是一个关于颜色的详细描述",
code = code, // 显示的唯一标识符
position = 0 // 可选的,若按数组排序则指定其位置
)
public String getDescription() {
return description;
}
}
```
在这里,`@ApiModelProperty` 注解里的`value`属性用于设置简短描述,`notes` 属性用于提供详细的解释,`code`属性则是自定义的值,与实际使用的枚举名称关联起来,方便在生成的文档中引用。
阅读全文