swagger返回枚举_真香警告！扩展 swagger支持文档自动列举所有枚举值

承接上篇文章 《一站式解决使用枚举的各种痛点》 文章最后提到：在使用 swagger 来编写接口文档时，需要告诉前端枚举类型有哪些取值，每次增加取值之后，不仅要改代码，还要找到对应的取值在哪里使用了，然后修改 swagger 文档。反正小黑我觉得这样做很不爽，那有没有什么办法可以让 swagger 框架来帮我们自动列举出所有的枚举数值呢？

这期小黑同学就来讲讲解决方案。

先来看一下效果，有一个感性的认识

请注意哦，这里是课程类型不是我们手动列举出来的，是swagger框架帮我们自动列举的。对应的代码如下：

那么，这是怎么做到的呢？

简单描述一下实现：

1、自定义 SwaggerDisplayEnum 注解，注解中有两个属性，这两个属性是用来干什么的呢？小黑我先不说，大家往下阅读，相信就能明白啦~

@Target({ElementType.TYPE})

@Retention(RetentionPolicy.RUNTIME)

public @interface SwaggerDisplayEnum {

String index() default "index";

String name() default "name";

}

2、在我们的自定义枚举类中标记 @SwaggerDisplayEnum 注解

@Getter

@AllArgsConstructor

@SwaggerDisplayEnum(index = "type", name = "desc")

public enum CourseType {

/**

* 图文

*/

PICTURE(102, "图文"),

/**

* 音频

*/

AUDIO(103, "音频"),

/**

* 视频

*/

VIDEO(104, "视频"),

/**

* 外链

*/

URL(105, "外链"),

;

@JsonValue

private final int type;

private final String desc;

private static final Map mappings;

<