From d9801f751f399006c5d96d3edbbcfa582975a8b0 Mon Sep 17 00:00:00 2001 From: frantuma Date: Tue, 5 Dec 2017 18:45:29 +0100 Subject: [PATCH] refs #2556 - updated logging for ApiImplicitParam with no datatype defined --- .../src/main/java/io/swagger/util/ReflectionUtils.java | 4 ++++ .../src/main/java/io/swagger/jaxrs/Reader.java | 3 +++ .../src/test/java/io/swagger/ReaderTest.java | 9 ++++++++- .../io/swagger/resources/ResourceWithImplicitParams.java | 3 ++- 4 files changed, 17 insertions(+), 2 deletions(-) diff --git a/modules/swagger-core/src/main/java/io/swagger/util/ReflectionUtils.java b/modules/swagger-core/src/main/java/io/swagger/util/ReflectionUtils.java index 54fa01db0e..52158cfc84 100644 --- a/modules/swagger-core/src/main/java/io/swagger/util/ReflectionUtils.java +++ b/modules/swagger-core/src/main/java/io/swagger/util/ReflectionUtils.java @@ -15,6 +15,7 @@ import com.google.common.collect.Sets; import org.apache.commons.lang3.ArrayUtils; +import org.apache.commons.lang3.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import com.fasterxml.jackson.databind.type.TypeFactory; @@ -27,6 +28,9 @@ public static Type typeFromString(String type) { if (primitive != null) { return primitive.getKeyClass(); } + if (StringUtils.isBlank(type)) { + return null; + } try { return loadClassByName(type); } catch (Exception e) { diff --git a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/Reader.java b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/Reader.java index a715d498da..fdfede7a96 100644 --- a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/Reader.java +++ b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/Reader.java @@ -474,6 +474,9 @@ protected Parameter readImplicitParam(ApiImplicitParam param) { } final Type type = param.dataTypeClass() == Void.class ? ReflectionUtils.typeFromString(param.dataType()) : param.dataTypeClass(); + if (type == null) { + LOGGER.error("no dataType defined for implicit param `{}`! resolved parameter will not have a type defined, and will therefore be not compliant with spec. see https://github.com/swagger-api/swagger-core/issues/2556.", param.name()); + } return ParameterProcessor.applyAnnotations(swagger, p, (type == null) ? String.class : type, Arrays.asList(param)); } diff --git a/modules/swagger-jaxrs/src/test/java/io/swagger/ReaderTest.java b/modules/swagger-jaxrs/src/test/java/io/swagger/ReaderTest.java index d3718935b0..5b2e489986 100644 --- a/modules/swagger-jaxrs/src/test/java/io/swagger/ReaderTest.java +++ b/modules/swagger-jaxrs/src/test/java/io/swagger/ReaderTest.java @@ -228,7 +228,7 @@ public void scanImplicitParam() { Swagger swagger = getSwagger(ResourceWithImplicitParams.class); List params = swagger.getPath("/testString").getPost().getParameters(); assertNotNull(params); - assertEquals(params.size(), 7); + assertEquals(params.size(), 8); assertEquals(params.get(0).getName(), "sort"); assertEquals(params.get(0).getIn(), "query"); @@ -262,6 +262,13 @@ public void scanImplicitParam() { assertEquals(bodyParam.getName(), "body"); assertEquals(bodyParam.getIn(), "body"); assertTrue(bodyParam.getRequired()); + + queryParam = (QueryParameter) params.get(7); + assertEquals(queryParam.getName(), "description"); + assertEquals(queryParam.getIn(), "query"); + // see https://github.com/swagger-api/swagger-core/issues/2556. should be not null + assertNull(queryParam.getType()); + } @Test(description = "scan implicit params with file objct") diff --git a/modules/swagger-jaxrs/src/test/java/io/swagger/resources/ResourceWithImplicitParams.java b/modules/swagger-jaxrs/src/test/java/io/swagger/resources/ResourceWithImplicitParams.java index 8c69dcbea8..7d10f7840e 100644 --- a/modules/swagger-jaxrs/src/test/java/io/swagger/resources/ResourceWithImplicitParams.java +++ b/modules/swagger-jaxrs/src/test/java/io/swagger/resources/ResourceWithImplicitParams.java @@ -22,7 +22,8 @@ public class ResourceWithImplicitParams { @ApiImplicitParam(name = "width", paramType = "formData", dataType = "int", allowableValues = "range[infinity,1]"), @ApiImplicitParam(name = "height", paramType = "query", dataType = "int", allowableValues = "range[3,4]"), @ApiImplicitParam(name = "body", paramType = "body", dataType = "string", required = true), - @ApiImplicitParam(name = "width", paramType = "unknown") + @ApiImplicitParam(name = "width", paramType = "unknown"), + @ApiImplicitParam(name = "description", paramType = "query") }) @ApiOperation("Test operation with implicit parameters") public void testString() {