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.

Sign up for GitHub

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

#4103 Support for Jackson reference types #4106

Merged
merged 2 commits into from
Nov 2, 2022
Merged

#4103 Support for Jackson reference types #4106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ae2634
#4103 Support for Jackson reference types
dpeger Jan 26, 2022
37ba7e5
#4103 Support for Jackson reference types
dpeger Jan 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...es/swagger-core/src/main/java/io/swagger/v3/core/converter/ModelConverterContextImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package io.swagger.v3.core.converter;

import io.swagger.v3.core.util.OptionalUtils;
import io.swagger.v3.core.util.ReferenceTypeUtils;
import io.swagger.v3.oas.models.media.Schema;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
Expand Down Expand Up @@ -76,7 +76,7 @@ public Map<String, Schema> getDefinedModels() {
@Override
public Schema resolve(AnnotatedType type) {

AnnotatedType aType = OptionalUtils.unwrapOptional(type);
AnnotatedType aType = ReferenceTypeUtils.unwrapReference(type);
if (aType != null) {
return resolve(aType);
}
Expand Down
4 changes: 2 additions & 2 deletions modules/swagger-core/src/main/java/io/swagger/v3/core/jackson/ModelResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
import io.swagger.v3.core.util.Constants;
import io.swagger.v3.core.util.Json;
import io.swagger.v3.core.util.ObjectMapperFactory;
import io.swagger.v3.core.util.OptionalUtils;
import io.swagger.v3.core.util.ReferenceTypeUtils;
import io.swagger.v3.core.util.PrimitiveType;
import io.swagger.v3.core.util.ReflectionUtils;
import io.swagger.v3.oas.annotations.Hidden;
Expand Down Expand Up @@ -497,7 +497,7 @@ public Schema resolve(AnnotatedType annotatedType, ModelConverterContext context
.type("object")
.name(name);
} else {
AnnotatedType aType = OptionalUtils.unwrapOptional(annotatedType);
AnnotatedType aType = ReferenceTypeUtils.unwrapReference(annotatedType);
if (aType != null) {
model = context.resolve(aType);
return model;
Expand Down
15 changes: 7 additions & 8 deletions ...o/swagger/v3/core/util/OptionalUtils.java → ...gger/v3/core/util/ReferenceTypeUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,22 @@

import java.util.Arrays;

public abstract class OptionalUtils {
public abstract class ReferenceTypeUtils {

private static Logger LOGGER = LoggerFactory.getLogger(OptionalUtils.class);
private static Logger LOGGER = LoggerFactory.getLogger(ReferenceTypeUtils.class);

public static boolean _isOptionalType(JavaType jtype) {
public static boolean _isReferenceType(JavaType jtype) {

return Arrays.asList("com.google.common.base.Optional", "java.util.Optional")
.contains(jtype.getRawClass().getCanonicalName());
.contains(jtype.getRawClass().getCanonicalName()) || jtype.isReferenceType();
}

/**
* check if type is an Optional type, returns the unwrapped type in case, otherwise null
* check if type is a reference type, returns the unwrapped type in case, otherwise null
*
* @param type
*
*/
public static AnnotatedType unwrapOptional(AnnotatedType type) {
public static AnnotatedType unwrapReference(AnnotatedType type) {

if (type == null) {
return type;
Expand All @@ -36,7 +35,7 @@ public static AnnotatedType unwrapOptional(AnnotatedType type) {
jtype = Json.mapper().constructType(type.getType());
}

if (_isOptionalType(jtype)) {
if (_isReferenceType(jtype)) {
AnnotatedType aType = new AnnotatedType()
.type(jtype.containedType(0))
.name(type.getName())
Expand Down
66 changes: 66 additions & 0 deletions modules/swagger-core/src/test/java/io/swagger/v3/core/util/ReferenceTypeUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
package io.swagger.v3.core.util;

import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.type.TypeFactory;
import io.swagger.v3.core.converter.AnnotatedType;
import org.checkerframework.checker.units.qual.A;
import org.testng.Assert;
import org.testng.annotations.Test;

import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.math.BigDecimal;
import java.util.concurrent.atomic.AtomicReference;

/**
* Unit test cases for {@link ReferenceTypeUtils}
*/
public class ReferenceTypeUtilsTest {

@Test(description = "AtomicReference should be reference type")
public void testIsReferenceTypeWithAtomicReference() {
final JavaType referredType = TypeFactory.defaultInstance().constructType(String.class);
final Class<AtomicReference> rawType = AtomicReference.class;
final JavaType atomicReferenceType = TypeFactory.defaultInstance().constructReferenceType(rawType, referredType);

final boolean actualIsReferenceType = ReferenceTypeUtils._isReferenceType(atomicReferenceType);

Assert.assertEquals(actualIsReferenceType, true, rawType.getCanonicalName() + " should be reference type but was not.");
}

@Test(description = "AtomicReference JavaType should be unwrapped")
public void testUnwrapWithAtomicReferenceAndJavaType() {
final JavaType expectedReferredType = TypeFactory.defaultInstance().constructType(String.class);

final Class<AtomicReference> rawType = AtomicReference.class;
final JavaType atomicReferenceType = TypeFactory.defaultInstance().constructReferenceType(rawType, expectedReferredType);

final AnnotatedType actualUnwrappedType = ReferenceTypeUtils.unwrapReference(new AnnotatedType(atomicReferenceType));

Assert.assertEquals(actualUnwrappedType.getType(), expectedReferredType, rawType.getCanonicalName() + "Reference type not correctly unwrapped");
}

@Test(description = "AtomicReference should be unwrapped when read from Java bean")
public void testUnwrapWithAtomicReferenceMemberFromJavaBean() throws Exception {
final JavaType expectedReferredType = TypeFactory.defaultInstance().constructType(BigDecimal.class);

final Type genericType = TypeWithAtomicReferenceMember.class.getDeclaredField("member").getGenericType();
final AnnotatedType actualUnwrappedType = ReferenceTypeUtils.unwrapReference(new AnnotatedType(genericType));

Assert.assertEquals(actualUnwrappedType.getType(), expectedReferredType, genericType.getTypeName() + "Reference type not correctly unwrapped");
}

@SuppressWarnings("unused")
private static final class TypeWithAtomicReferenceMember {
AtomicReference<BigDecimal> member;

public AtomicReference<BigDecimal> getMember() {
return member;
}

public void setMember(AtomicReference<BigDecimal> member) {
this.member = member;
}
}

}