如何正确配置枚举？

Question

我正在Java Spring/Hibernate中使用Swagger-UI。Swagger UI版本是2。

我很难使用枚举。

@Enumerated(EnumType.STRING)
@Column(name = "gender")
@Access(AccessType.FIELD)
private Gender gender;

public enum Gender {

    M("Male"), F("Female");

    private String displayValue;

    private Gender(String displayValue) {
        this.displayValue = displayValue;
    }

    @Override
    public String toString() {
        return displayValue;
    }

    public String getDisplayValue() {
        return displayValue;
    }

    public String getName() {
        return name();
    }   
}

<select name="gender">
<option value="M">Male</option>
<option value="F">Female</option>
</select>

Answer 1

您需要通过实现接口springfox.documentation.service.AllowableValues来创建自定义类(AllowableMapValues)，该接口将返回Map类型而不是列表类型。（参见类springfox.documentation.service.AllowableListValues以获得参考）。

之后，您需要在SpringFox.documentation.schema.enums类中使用静态方法，方法是隐藏静态方法(AllowableValuesAllowableValues(class type))，返回新创建的AllowableMapValues类

public static AllowableValues allowableValues(Class<?> type) {
    if (type.isEnum()) {
      Map<String, String> enumValues = getEnumMapValues(type);
      return new AllowableMapValues(enumValues, "MAP");
    }
    return null;
  }

其中<“k”,“v”>对类似于<“m”,“mene”>

您应该创建静态方法GetEnummapValues，其工作方式与Enums类中的GetEnumValues方法相同。

现在swagger将被生成为所需的类型。

@JsonValue  
public String enumName() {
    return name();
}

你可以试试上面的方法，如果它解决了问题