增加全局配置,后续只需在枚举字段指明枚举类位置,不需要写繁琐的说明
@Configuration
@EnableSwagger2
@Slf4j
public class Swagger2Config implements ModelPropertyBuilderPlugin {
@Override
public void apply(ModelPropertyContext context){
Optional<ApiModelProperty> annotation = Optional.absent();
if(context.getAnnotatedElement().isPresent()) {
annotation = annotation.or(ApiModelProperties.findApiModePropertyAnnotation(context.getAnnotatedElement().get()));
}
if(context.getBeanPropertyDefinition().isPresent()) {
annotation = annotation.or(Annotations.findPropertyAnnotation(context.getBeanPropertyDefinition().get(),ApiModelProperty.class));
}
// 没有@ApiModelProperty或者notes属性没值则直接返回
if(!annotation.isPresent() || StringUtils.isBlank((annotation.get()).notes())) {
return;
}
Class enumType;
try {
enumType = Class.forName((annotation.get()).notes().replaceAll("/","."));
} catch(ClassNotFoundException e) {
// 若转换失败,直接忽略,不阻塞流程
log.warn(e.getMessage());
return;
}
Object[] subItemRecords = null;
if(Enum.class.isAssignableFrom(enumType)) {
subItemRecords = rawPrimaryType.getEnumConstants();
}
if(subItemRecords == null){
return;
}
final List<String> displayValues = Arrays.stream(subItemRecords)
.filter(Objects::nonNull)
.map(Objects::toString)
.collect(Collectors.toList());
String joinText = " (" + String.join("; ",displayValues) + ")"";
try {
Field mField = ModelPropertyBuilder.class.getDeclaredField("description");
mField.setAccessible(true);
joinText = mField.get(context.getBuilder()) + joinText;
}catch(Exception e){
log.error(e.getMessage());
}
// 枚举固定为int类型
final ResolvedType resolvedType = context.getResolver().resolve(Integer.class);
context.getBuilder().description(joinText).type(resolvedType);
}
// Swagger2还需其他一切配置,此处不再赘述
}
实际使用时:
@Data
@ApiModel(value= "TestQuery",description="qwe")
public class TestQuery {
@ApimodelProperty(value="枚举",notes="com/xxx/xx/TestEnum")
private TestEnum testEnum;
}