Java的Swagger+Jersey数字枚举

Question

我的Rest API中有一个字段（在Jersey+jackson+Bean Validation中实现），它是一组封闭的数值。例如，员工等级，它可以是以下值之一:1,2,5,7。而不是,则不能为每个值定义匹配字符串。

我正在尝试获得生成的swagger文档，以便为这些值提供一个数字枚举。我尝试了以下方法：

>

使用以下属性定义整数:@apimodelproperty(allowableValues=“1,2,5,7”）Integer employeeRank。swagger-ui没有显示任何枚举，只是在将employeeRank的类型更改为string之后。因此不幸的是，allowableValues只能与String参数一起工作，而我不希望我的模型是这样的。employeeRank必须是整数。

定义枚举：

@JsonSerialize(using = BlockSize.OrderTypeSerializer.class)
@JsonDeserialize(using = BlockSize.OrderTypeDeserializer.class)
public enum EmployeeRank {
    ONW(1),
    TWO(2),
    FIVE(5),
    SEVEN(7)
int rank;

EmployeeRank(int rank) {
    this.rank = rank;
}

@JsonValue
public int getRank() {
    return rank;
}

public class RankSerializer extends JsonSerializer<EmployeeRank> {


    @Override
    public void serialize(EmployeeRank rank, JsonGenerator generator, SerializerProvider serializerProvider) throws IOException, JsonProcessingException {
        generator.writeStartObject();
        generator.writeFieldName("rank");
        generator.writeNumber(rank.getRank());
        generator.writeEndObject();
    }
}

public class RankDeserializer extends JsonDeserializer<EmployeeRank> {

    @Override
    public EmployeeRank deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
        int val =jsonParser.getValueAsInt();
        if (val == 1) {
            return ONE;
        }

        if (val == 2) {
            return TWO;
        }

        if (val == 5) {
            return FIVE;
        }

        if (val == 7) {
            return SEVEN;
        }

        throw new IOException("Illiegal rank value " + val);
    }
} 

没有运气。swagger-ui将枚举以枚举名称（一、二、五、七）的形式呈现

用Swagger在Jersey中定义一组数值来理解它，这似乎是一个相当琐碎的任务。知道吗？

以下是我的资源：

        resourceConfig.packages(true, ResponseWrapper.class.getPackage().getName());
        resourceConfig.property(ServerProperties.BV_SEND_ERROR_IN_RESPONSE, true);
        resourceConfig.property(ServerProperties.BV_DISABLE_VALIDATE_ON_EXECUTABLE_OVERRIDE_CHECK, true);


            resourceConfig.register(ApiListingResource.class);
            resourceConfig.register(SwaggerSerializers.class);

        resourceConfig.register(EncodingFilter.class);
        resourceConfig.register(GZipEncoder.class);
        resourceConfig.register(DeflateEncoder.class);
        resourceConfig.register(JacksonFeature.class);
        resourceConfig.register(MultiPartFeature.class);
        resourceConfig.register(ValidationConfigurationContextResolver.class);

和我的Swagger初始化器：

 BeanConfig beanConfig = new BeanConfig();
        beanConfig.setVersion("3.0");
        beanConfig.setSchemes(new String[]{"https"});
        beanConfig.setHost("localhost");
        beanConfig.setBasePath("/api");
        beanConfig.setPrettyPrint(true);
        beanConfig.setResourcePackage(ApiLevel.class.getPackage().getName());
        beanConfig.setScan(true);

更新

在@fehguy的建议下，我升级到了jackson 2.7。而且有一些进展。请考虑以下枚举：

public enum Status {
        @JsonProperty("hello")
        ENUM1,
        @JsonProperty("world")
        ENUM2;
    }

运行以下主要应用程序工作：

public static void main(String[] args) throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        Status user = Status.ENUM1;

        System.out.println(mapper.writeValueAsString(user));
    }

输出是“hello”，这正是我需要的。

但是，swagger-ui仍然显示枚举值。也许它不处理枚举值上的JSONProperty注释？

Answer 1

这是一个jackson配置问题。看看在2.6.2或更高版本中使用@JSONProperty注释，它将允许您为枚举设置友好名称。