Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix #4466 locate @JsonValue on enum interface method #4467

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -1096,13 +1096,17 @@ protected void _addEnumProps(Class<?> propClass, Schema property) {
final boolean useToString = _mapper.isEnabled(SerializationFeature.WRITE_ENUMS_USING_TO_STRING);

Optional<Method> jsonValueMethod = Arrays.stream(propClass.getDeclaredMethods())
.filter(m -> m.isAnnotationPresent(JsonValue.class))
.filter(m -> m.getAnnotation(JsonValue.class).value())
.filter(method -> {
JsonValue annotation = ReflectionUtils.getAnnotation(method, JsonValue.class);
return annotation != null && annotation.value();
})
.findFirst();

Optional<Field> jsonValueField = Arrays.stream(propClass.getDeclaredFields())
.filter(f -> f.isAnnotationPresent(JsonValue.class))
.filter(f -> f.getAnnotation(JsonValue.class).value())
.filter(field -> {
JsonValue annotation = field.getAnnotation(JsonValue.class);
return annotation != null && annotation.value();
})
.findFirst();

jsonValueMethod.ifPresent(m -> m.setAccessible(true));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -223,16 +223,21 @@ public void testExtractJacksonEnumFields() {
final Schema fourthEnumProperty = (Schema) model.getProperties().get("fourthEnumValue");
assertTrue(fourthEnumProperty instanceof StringSchema);
final StringSchema fourthStringProperty = (StringSchema) fourthEnumProperty;
assertEquals(fourthEnumProperty.getEnum(), Arrays.asList("one", "two", "three"));
assertEquals(fourthStringProperty.getEnum(), Arrays.asList("one", "two", "three"));

final Schema fifthEnumProperty = (Schema) model.getProperties().get("fifthEnumValue");
assertTrue(fifthEnumProperty instanceof StringSchema);
final StringSchema fifthStringProperty = (StringSchema) fifthEnumProperty;
assertEquals(fifthEnumProperty.getEnum(), Arrays.asList("2", "4", "6"));
assertEquals(fifthStringProperty.getEnum(), Arrays.asList("2", "4", "6"));

final Schema sixthEnumProperty = (Schema) model.getProperties().get("sixthEnumValue");
assertTrue(sixthEnumProperty instanceof StringSchema);
final StringSchema sixthStringProperty = (StringSchema) sixthEnumProperty;
assertEquals(sixthEnumProperty.getEnum(), Arrays.asList("one", "two", "three"));
assertEquals(sixthStringProperty.getEnum(), Arrays.asList("one", "two", "three"));

final Schema seventhEnumProperty = (Schema) model.getProperties().get("seventhEnumValue");
assertTrue(seventhEnumProperty instanceof StringSchema);
final StringSchema seventhStringProperty = (StringSchema) seventhEnumProperty;
assertEquals(seventhStringProperty.getEnum(), Arrays.asList("one", "two", "three"));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package io.swagger.v3.core.oas.models;

import com.fasterxml.jackson.annotation.JsonValue;

public interface IEnum {

@JsonValue
String getValue();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package io.swagger.v3.core.oas.models;

import io.swagger.v3.oas.annotations.Hidden;

/**
* Enum holds values different from names.
* Schema model will derive String value from jackson annotation JsonValue on public implemented method.
*/
public enum JacksonValueImplementingEnum implements IEnum {
FIRST("one"),
SECOND("two"),
THIRD("three"),
@Hidden HIDDEN("hidden");

private final String value;

JacksonValueImplementingEnum(String value) {
this.value = value;
}

@Override
public String getValue() {
return value;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ public class ModelWithJacksonEnumField {
public JacksonValueFieldEnum fourthEnumValue;
public JacksonNumberValueFieldEnum fifthEnumValue;
public JacksonValuePrivateEnum sixthEnumValue;
public JacksonValueImplementingEnum seventhEnumValue;
}