#4103 Support for Jackson reference types

In addition to the hard coded `Optional` reference types the type information from jackson is used to unwrap additional reference types (e.g. `AtomicReference`)
swagger-api · Nov 2, 2022 · e0b2e93 · e0b2e93
1 parent 2aab91e
commit e0b2e93
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 3 deletions.
diff --git a/modules/swagger-core/src/main/java/io/swagger/jackson/ModelResolver.java b/modules/swagger-core/src/main/java/io/swagger/jackson/ModelResolver.java
@@ -170,7 +170,7 @@ public Property resolveProperty(JavaType propType,
             if (propType.isEnumType()) {
                 property = new StringProperty();
                 _addEnumProps(propType.getRawClass(), (StringProperty) property);
-            } else if (_isOptionalType(propType)) {
+            } else if (_isReferenceType(propType)) {
                 property = context.resolveProperty(propType.containedType(0), null);
             } else {
                 // complex type
@@ -191,9 +191,9 @@ public Property resolveProperty(JavaType propType,
         return property;
     }
 
-    private boolean _isOptionalType(JavaType propType) {
+    private boolean _isReferenceType(JavaType propType) {
         return Arrays.asList("com.google.common.base.Optional", "java.util.Optional")
-                .contains(propType.getRawClass().getCanonicalName());
+                .contains(propType.getRawClass().getCanonicalName()) || propType.isReferenceType();
     }
 
     @Override

diff --git a/modules/swagger-core/src/test/java/io/swagger/jackson/ModelResolverTest.java b/modules/swagger-core/src/test/java/io/swagger/jackson/ModelResolverTest.java
@@ -1,17 +1,26 @@
 package io.swagger.jackson;
 
+import com.fasterxml.jackson.databind.BeanDescription;
 import com.fasterxml.jackson.databind.JavaType;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition;
+import com.fasterxml.jackson.databind.type.TypeFactory;
 import io.swagger.converter.ModelConverterContextImpl;
 import io.swagger.models.Link;
 import io.swagger.models.Model;
 import io.swagger.models.ModelImpl;
 import io.swagger.models.Xml;
+import io.swagger.models.properties.DecimalProperty;
+import io.swagger.models.properties.Property;
 import org.testng.annotations.DataProvider;
 import org.testng.annotations.Test;
 
 import javax.xml.bind.annotation.XmlRootElement;
 
+import java.lang.annotation.Annotation;
+import java.math.BigDecimal;
+import java.util.concurrent.atomic.AtomicReference;
+
 import static org.testng.Assert.*;
 
 public class ModelResolverTest extends SwaggerTestBase {
@@ -51,4 +60,39 @@ public static class TypeWithNamespace {
     public static class TypeWithoutNamespace {
     }
 
+    @Test
+    public void testResolvePropertyWithAtomicReference() {
+        final ObjectMapper mapper = mapper();
+        final ModelResolver modelResolver = new ModelResolver(mapper);
+
+        final JavaType javaType = TypeFactory.defaultInstance().constructType(TypeWithAtomicReferenceMember.class);
+        final BeanDescription beanDescription = mapper.getSerializationConfig().introspect(javaType);
+
+        JavaType atomicReferenceBigDecimalType = null;
+        for (final BeanPropertyDefinition propDef : beanDescription.findProperties()) {
+            if ("member".equals(propDef.getName())) {
+                atomicReferenceBigDecimalType = propDef.getPrimaryType();
+            }
+        }
+        assertNotNull(atomicReferenceBigDecimalType, "Failed to read atomic reference field 'member'");
+
+        final Property actualProperty = modelResolver.resolveProperty(atomicReferenceBigDecimalType,
+                new ModelConverterContextImpl(modelResolver), new Annotation[0], null);
+        assertEquals(actualProperty.getType(), DecimalProperty.TYPE, "Got wrong type for AtomicReference member");
+    }
+
+    @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;
+        }
+    }
+
+
 }