ref #3286 - prioritize schema name resolving by ApiModel.value

Author: frantuma

modules/swagger-core/src/main/java/io/swagger/jackson/AbstractModelConverter.java

@@ -9,11 +9,13 @@
 import com.fasterxml.jackson.databind.introspect.Annotated;
 import com.fasterxml.jackson.databind.jsontype.NamedType;
 import com.fasterxml.jackson.databind.module.SimpleModule;
+import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiModelProperty;
 import io.swagger.converter.ModelConverter;
 import io.swagger.converter.ModelConverterContext;
 import io.swagger.models.Model;
 import io.swagger.models.properties.Property;
+import org.apache.commons.lang3.StringUtils;
 
 import javax.xml.bind.annotation.XmlElement;
 import java.lang.annotation.Annotation;
@@ -102,6 +104,16 @@ protected String _typeName(JavaType type, BeanDescription beanDesc) {
         return name;
     }
 
+    /**
+     * whether to resolve schema name by first using AnnotationInspector registered implementations
+     * defaults to false, override returning `true` to obtain pre-1.5.24 behaviour
+     *
+     * @return false
+     * @since 1.5.24
+     */
+    protected boolean prioritizeAnnotationInspectorSchemaName() {
+        return false;
+    }
     protected String _findTypeName(JavaType type, BeanDescription beanDesc) {
         // First, handle container types; they require recursion
         if (type.isArrayType()) {
@@ -122,6 +134,12 @@ protected String _findTypeName(JavaType type, BeanDescription beanDesc) {
             beanDesc = _mapper.getSerializationConfig().introspectClassAnnotations(type);
         }
 
+        if (!prioritizeAnnotationInspectorSchemaName()) {
+            final ApiModel model = type.getRawClass().getAnnotation(ApiModel.class);
+            if (model != null && StringUtils.isNotBlank(model.value())) {
+                return _typeNameResolver.nameForType(type);
+            }
+        }
         PropertyName rootName = _intr.findRootName(beanDesc.getClassInfo());
         if (rootName != null && rootName.hasSimpleName()) {
             return rootName.getSimpleName();

modules/swagger-jaxrs/src/test/java/io/swagger/SimpleReaderTest.java

@@ -31,6 +31,7 @@
 import io.swagger.resources.ClassWithExamplePostClass;
 import io.swagger.resources.HiddenResource;
 import io.swagger.resources.Issue1979Resource;
+import io.swagger.resources.Issue3286Resource;
 import io.swagger.resources.NicknamedOperation;
 import io.swagger.resources.NotValidRootResource;
 import io.swagger.resources.Resource1041;
@@ -716,4 +717,14 @@ public void scanClassWithReadOnlyAndEmptyValueParams() {
         SerializableParameter allowEmptyParam = (SerializableParameter) swagger.getPath("/fun/allowEmpty").getGet().getParameters().get(0);
         assertTrue(allowEmptyParam.getAllowEmptyValue());
     }
+
+    @Test
+    public void testTicket3286() {
+        Swagger swagger = getSwagger(Issue3286Resource.class);
+        BodyParameter bodyParam = (BodyParameter)swagger.getPath("/fun/{id}").getPost().getParameters().get(1);
+        assertEquals(bodyParam.getSchema().getReference(), "#/definitions/BookRequest");
+        assertEquals(swagger.getPath("/fun/{id}").getPost().getResponses().get("200").getResponseSchema().getReference(), "#/definitions/BookResponse");
+        assertTrue(swagger.getDefinitions().containsKey("BookRequest"));
+        assertTrue(swagger.getDefinitions().containsKey("BookResponse"));
+    }
 }

modules/swagger-jaxrs/src/test/java/io/swagger/resources/Issue3286Resource.java

@@ -0,0 +1,49 @@
+package io.swagger.resources;
+
+import com.fasterxml.jackson.annotation.JsonRootName;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiResponse;
+import io.swagger.annotations.ApiResponses;
+
+import javax.ws.rs.POST;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.core.Response;
+import javax.xml.bind.annotation.XmlRootElement;
+
+@Api(value = "test")
+@Path("fun")
+public class Issue3286Resource {
+
+    @POST
+    @Path("/{id}")
+    @ApiOperation(value = "test")
+    @ApiResponses(value = {
+            @ApiResponse(code = 200, message = "Ok", response = BookResponse.class),
+            @ApiResponse(code = 400, message = "Ko", response = Error.class),
+    })
+    public Response test(@PathParam(value = "id") String bookId, BookRequest book) {
+        return Response.ok().build();
+    }
+
+
+    @ApiModel(value = "BookResponse", description = "descResponse")
+    @XmlRootElement(name = "book")
+    @JsonRootName("book")
+    public static class BookResponse {
+        public String foo;
+    }
+
+    @ApiModel(value = "BookRequest", description = "desc")
+    @XmlRootElement(name = "book")
+    @JsonRootName("book")
+    public static class BookRequest {
+        public String bar;
+    }
+
+    public static class Error {
+        public String err;
+    }
+}