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 bc6c032ebd..3edfd727e3 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 @@ -45,7 +45,6 @@ import io.swagger.models.Response; import io.swagger.models.Scheme; import io.swagger.models.SecurityRequirement; -import io.swagger.models.SecurityScope; import io.swagger.models.Swagger; import io.swagger.models.Tag; import io.swagger.models.parameters.FormParameter; @@ -61,7 +60,6 @@ import io.swagger.util.ParameterProcessor; import io.swagger.util.PathUtils; import io.swagger.util.ReflectionUtils; - import org.apache.commons.lang3.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -98,10 +96,14 @@ public Reader(Swagger swagger) { } public Reader(Swagger swagger, ReaderConfig config) { - this.swagger = swagger == null ? new Swagger() : swagger; + this.swagger = (swagger == null) ? new Swagger() : swagger; this.config = new DefaultReaderConfig(config); } + public Swagger getSwagger() { + return swagger; + } + /** * Scans a set of classes for both ReaderListeners and Swagger annotations. All found listeners will * be instantiated before any of the classes are scanned for Swagger annotations - so they can be invoked @@ -110,9 +112,7 @@ public Reader(Swagger swagger, ReaderConfig config) { * @param classes a set of classes to scan * @return the generated Swagger definition */ - public Swagger read(Set> classes) { - Map, ReaderListener> listeners = new HashMap, ReaderListener>(); for (Class cls : classes) { @@ -156,16 +156,10 @@ public Swagger read(Set> classes) { return swagger; } - public Swagger getSwagger() { - return this.swagger; - } - /** * Scans a single class for Swagger annotations - does not invoke ReaderListeners */ - public Swagger read(Class cls) { - SwaggerDefinition swaggerDefinition = cls.getAnnotation(SwaggerDefinition.class); if (swaggerDefinition != null) { readSwaggerConfig(cls, swaggerDefinition); @@ -173,13 +167,12 @@ public Swagger read(Class cls) { return read(cls, "", null, false, new String[0], new String[0], new HashMap(), new ArrayList(), new HashSet>()); } + protected Swagger read(Class cls, String parentPath, String parentMethod, boolean isSubresource, String[] parentConsumes, String[] parentProduces, Map parentTags, List parentParameters) { return read(cls, parentPath, parentMethod, isSubresource, parentConsumes, parentProduces, parentTags, parentParameters, new HashSet>()); } private Swagger read(Class cls, String parentPath, String parentMethod, boolean isSubresource, String[] parentConsumes, String[] parentProduces, Map parentTags, List parentParameters, Set> scannedResources) { - Map globalScopes = new HashMap(); - Map tags = new HashMap(); List securities = new ArrayList(); @@ -194,7 +187,7 @@ private Swagger read(Class cls, String parentPath, String parentMethod, boole boolean isApiHidden = hasApiAnnotation && api.hidden(); // class readable only if annotated with @Path or isSubresource, or and @Api not hidden - boolean classReadable = (hasPathAnnotation || isSubresource) && !isApiHidden ; + boolean classReadable = (hasPathAnnotation || isSubresource) && !isApiHidden; // readable if classReadable or (scanAllResources true in config and @Api not hidden) boolean readable = classReadable || (!isApiHidden && config.isScanAllResources()); @@ -204,7 +197,7 @@ private Swagger read(Class cls, String parentPath, String parentMethod, boole } // api readable only if @Api present; cannot be hidden because checked in classReadable. - boolean apiReadable = hasApiAnnotation; + boolean apiReadable = hasApiAnnotation; if (apiReadable) { // the value will be used as a tag for 2.0 UNLESS a Tags annotation is present @@ -218,21 +211,19 @@ private Swagger read(Class cls, String parentPath, String parentMethod, boole } if (!api.produces().isEmpty()) { - produces = ReaderUtils.splitContentValues(new String[] {api.produces()}); + produces = ReaderUtils.splitContentValues(new String[]{api.produces()}); } if (!api.consumes().isEmpty()) { - consumes = ReaderUtils.splitContentValues(new String[] {api.consumes()}); + consumes = ReaderUtils.splitContentValues(new String[]{api.consumes()}); } globalSchemes.addAll(parseSchemes(api.protocols())); - Authorization[] authorizations = api.authorizations(); - for (Authorization auth : authorizations) { - if (auth.value() != null && !"".equals(auth.value())) { + for (Authorization auth : api.authorizations()) { + if (auth.value() != null && !auth.value().isEmpty()) { SecurityRequirement security = new SecurityRequirement(); security.setName(auth.value()); - AuthorizationScope[] scopes = auth.scopes(); - for (AuthorizationScope scope : scopes) { - if (scope.scope() != null && !"".equals(scope.scope())) { + for (AuthorizationScope scope : auth.scopes()) { + if (scope.scope() != null && !scope.scope().isEmpty()) { security.addScope(scope.scope()); } } @@ -242,7 +233,6 @@ private Swagger read(Class cls, String parentPath, String parentMethod, boole } if (readable) { - if (isSubresource) { if (parentTags != null) { tags.putAll(parentTags); @@ -295,7 +285,7 @@ private Swagger read(Class cls, String parentPath, String parentMethod, boole String httpMethod = extractOperationMethod(apiOperation, method, SwaggerExtensions.chain()); Operation operation = null; - if(apiOperation != null || config.isScanAllResources() || httpMethod != null || methodPath != null) { + if (apiOperation != null || config.isScanAllResources() || httpMethod != null || methodPath != null) { operation = parseMethod(cls, method, globalParameters, classApiResponses); } if (operation == null) { @@ -356,10 +346,9 @@ private Swagger read(Class cls, String parentPath, String parentMethod, boole } // can't continue without a valid http method - httpMethod = httpMethod == null ? parentMethod : httpMethod; + httpMethod = (httpMethod == null) ? parentMethod : httpMethod; if (httpMethod != null) { if (apiOperation != null) { - boolean hasExplicitTag = false; for (String tag : apiOperation.tags()) { if (!"".equals(tag)) { operation.tag(tag); @@ -411,7 +400,7 @@ private Swagger read(Class cls, String parentPath, String parentMethod, boole private void readImplicitParameters(Method method, Operation operation) { ApiImplicitParams implicitParams = ReflectionUtils.getAnnotation(method, ApiImplicitParams.class); - if (implicitParams != null && implicitParams.value().length > 0) { + if (implicitParams != null) { for (ApiImplicitParam param : implicitParams.value()) { Parameter p = readImplicitParam(param); if (p != null) { @@ -438,12 +427,11 @@ protected Parameter readImplicitParam(ApiImplicitParam param) { return null; } final Type type = ReflectionUtils.typeFromString(param.dataType()); - return ParameterProcessor.applyAnnotations(swagger, p, type == null ? String.class : type, + return ParameterProcessor.applyAnnotations(swagger, p, (type == null) ? String.class : type, Arrays.asList(param)); } protected void readSwaggerConfig(Class cls, SwaggerDefinition config) { - if (!config.basePath().isEmpty()) { swagger.setBasePath(config.basePath()); } @@ -688,7 +676,7 @@ String getPath(javax.ws.rs.Path classLevelPath, javax.ws.rs.Path methodLevelPath private Map parseResponseHeaders(ResponseHeader[] headers) { Map responseHeaders = null; - if (headers != null && headers.length > 0) { + if (headers != null) { for (ResponseHeader header : headers) { String name = header.name(); if (!"".equals(name)) { @@ -734,52 +722,46 @@ private Operation parseMethod(Class cls, Method method, List globa if (apiOperation.hidden()) { return null; } - if (!"".equals(apiOperation.nickname())) { + if (!apiOperation.nickname().isEmpty()) { operationId = apiOperation.nickname(); } defaultResponseHeaders = parseResponseHeaders(apiOperation.responseHeaders()); - operation - .summary(apiOperation.value()) + operation.summary(apiOperation.value()) .description(apiOperation.notes()); - if (apiOperation.response() != null && !isVoid(apiOperation.response())) { + if (!isVoid(apiOperation.response())) { responseType = apiOperation.response(); } - if (!"".equals(apiOperation.responseContainer())) { + if (!apiOperation.responseContainer().isEmpty()) { responseContainer = apiOperation.responseContainer(); } - if (apiOperation.authorizations() != null) { - List securities = new ArrayList(); - for (Authorization auth : apiOperation.authorizations()) { - if (auth.value() != null && !"".equals(auth.value())) { - SecurityRequirement security = new SecurityRequirement(); - security.setName(auth.value()); - AuthorizationScope[] scopes = auth.scopes(); - for (AuthorizationScope scope : scopes) { - if (scope.scope() != null && !"".equals(scope.scope())) { - security.addScope(scope.scope()); - } + List securities = new ArrayList(); + for (Authorization auth : apiOperation.authorizations()) { + if (!auth.value().isEmpty()) { + SecurityRequirement security = new SecurityRequirement(); + security.setName(auth.value()); + for (AuthorizationScope scope : auth.scopes()) { + if (!scope.scope().isEmpty()) { + security.addScope(scope.scope()); } - securities.add(security); - } - } - if (securities.size() > 0) { - for (SecurityRequirement sec : securities) { - operation.security(sec); } + securities.add(security); } } - if (apiOperation.consumes() != null && !apiOperation.consumes().isEmpty()) { - String[] consumesAr = ReaderUtils.splitContentValues(new String[] {apiOperation.consumes()}); - for (String consume: consumesAr) { + for (SecurityRequirement sec : securities) { + operation.security(sec); + } + if (!apiOperation.consumes().isEmpty()) { + String[] consumesAr = ReaderUtils.splitContentValues(new String[]{apiOperation.consumes()}); + for (String consume : consumesAr) { operation.consumes(consume); } } - if (apiOperation.produces() != null && !apiOperation.produces().isEmpty()) { - String[] producesAr = ReaderUtils.splitContentValues(new String[] {apiOperation.produces()}); - for (String produce: producesAr) { + if (!apiOperation.produces().isEmpty()) { + String[] producesAr = ReaderUtils.splitContentValues(new String[]{apiOperation.produces()}); + for (String produce : producesAr) { operation.produces(produce); } } @@ -798,7 +780,7 @@ private Operation parseMethod(Class cls, Method method, List globa final Property property = ModelConverters.getInstance().readAsProperty(responseType); if (property != null) { final Property responseProperty = ContainerWrapper.wrapContainer(responseContainer, property); - final int responseCode = apiOperation == null ? 200 : apiOperation.code(); + final int responseCode = (apiOperation == null) ? 200 : apiOperation.code(); operation.response(responseCode, new Response().description(SUCCESSFUL_OPERATION).schema(responseProperty) .headers(defaultResponseHeaders)); appendModels(responseType); @@ -843,8 +825,10 @@ private Operation parseMethod(Class cls, Method method, List globa } // merge class level @ApiResponse for (ApiResponse apiResponse : classApiResponses) { - String key = apiResponse.code() == 0 ? "default":String.valueOf(apiResponse.code()); - if (operation.getResponses() != null && operation.getResponses().containsKey(key)) continue; + String key = (apiResponse.code() == 0) ? "default" : String.valueOf(apiResponse.code()); + if (operation.getResponses() != null && operation.getResponses().containsKey(key)) { + continue; + } addResponse(operation, apiResponse); } @@ -875,7 +859,7 @@ private Operation parseMethod(Class cls, Method method, List globa return operation; } - private void addResponse (Operation operation, ApiResponse apiResponse) { + private void addResponse(Operation operation, ApiResponse apiResponse) { Map responseHeaders = parseResponseHeaders(apiResponse.responseHeaders()); Response response = new Response() @@ -911,7 +895,7 @@ private List getParameters(Type type, List annotations) { LOGGER.debug("trying extension " + extension); final List parameters = extension.extractParameters(annotations, type, typesToSkip, chain); - if (parameters.size() > 0) { + if (!parameters.isEmpty()) { final List processed = new ArrayList(parameters.size()); for (Parameter parameter : parameters) { if (ParameterProcessor.applyAnnotations(swagger, parameter, type, annotations) != null) { @@ -933,7 +917,7 @@ private List getParameters(Type type, List annotations) { } public String extractOperationMethod(ApiOperation apiOperation, Method method, Iterator chain) { - if (apiOperation != null && apiOperation.httpMethod() != null && !"".equals(apiOperation.httpMethod())) { + if (apiOperation != null && !"".equals(apiOperation.httpMethod())) { return apiOperation.httpMethod().toLowerCase(); } else if (method.getAnnotation(javax.ws.rs.GET.class) != null) { return "get"; @@ -952,7 +936,7 @@ public String extractOperationMethod(ApiOperation apiOperation, Method method, I } else if (method.getAnnotation(HttpMethod.class) != null) { HttpMethod httpMethod = method.getAnnotation(HttpMethod.class); return httpMethod.value().toLowerCase(); - } else if(!StringUtils.isEmpty(getHttpMethodFromCustomAnnotations(method))) { + } else if (!StringUtils.isEmpty(getHttpMethodFromCustomAnnotations(method))) { return getHttpMethodFromCustomAnnotations(method); } else if ((ReflectionUtils.getOverriddenMethod(method)) != null) { return extractOperationMethod(apiOperation, ReflectionUtils.getOverriddenMethod(method), chain); @@ -964,9 +948,9 @@ public String extractOperationMethod(ApiOperation apiOperation, Method method, I } private String getHttpMethodFromCustomAnnotations(Method method) { - for(Annotation methodAnnotation : method.getAnnotations()){ + for (Annotation methodAnnotation : method.getAnnotations()) { HttpMethod httpMethod = methodAnnotation.annotationType().getAnnotation(HttpMethod.class); - if(httpMethod != null) { + if (httpMethod != null) { return httpMethod.value().toLowerCase(); } } @@ -1061,7 +1045,8 @@ protected Property doWrap(Property property) { } public static Property wrapContainer(String container, Property property, ContainerWrapper... allowed) { - final Set tmp = allowed.length > 0 ? EnumSet.copyOf(Arrays.asList(allowed)) : EnumSet.allOf(ContainerWrapper.class); + final Set tmp = (allowed.length > 0) ? EnumSet.copyOf(Arrays.asList(allowed)) + : EnumSet.allOf(ContainerWrapper.class); for (ContainerWrapper wrapper : tmp) { final Property prop = wrapper.wrap(container, property); if (prop != null) { diff --git a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/BeanConfig.java b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/BeanConfig.java index 0a096daaf8..f94b2cb0b3 100644 --- a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/BeanConfig.java +++ b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/BeanConfig.java @@ -1,6 +1,5 @@ package io.swagger.jaxrs.config; -import io.swagger.annotations.Api; import io.swagger.annotations.SwaggerDefinition; import io.swagger.config.FilterFactory; import io.swagger.config.Scanner; @@ -27,7 +26,7 @@ import java.util.Set; public class BeanConfig extends AbstractScanner implements Scanner, SwaggerConfig { - Logger LOGGER = LoggerFactory.getLogger(BeanConfig.class); + private static final Logger LOGGER = LoggerFactory.getLogger(BeanConfig.class); Reader reader = new Reader(new Swagger()); @@ -140,6 +139,7 @@ public void setHost(String host) { this.host = host; } + @Override public String getFilterClass() { return filterClass; } @@ -233,6 +233,7 @@ public void scanAndRead() { } } + @Override public Set> classes() { ConfigurationBuilder config = new ConfigurationBuilder(); Set acceptablePackages = new HashSet(); @@ -316,6 +317,7 @@ public Swagger getSwagger() { return reader.getSwagger(); } + @Override public Swagger configure(Swagger swagger) { if (schemes != null) { for (String scheme : schemes) { diff --git a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/DefaultJaxrsScanner.java b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/DefaultJaxrsScanner.java index 3b3df16f13..85119a617a 100644 --- a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/DefaultJaxrsScanner.java +++ b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/DefaultJaxrsScanner.java @@ -8,6 +8,7 @@ public class DefaultJaxrsScanner extends AbstractScanner implements JaxrsScanner { private boolean prettyPrint = false; + @Override public Set> classesFromContext(Application app, ServletConfig sc) { Set> output = new HashSet>(); if (app != null) { @@ -25,6 +26,7 @@ public Set> classesFromContext(Application app, ServletConfig sc) { return output; } + @Override public Set> classes() { return new HashSet>(); } @@ -33,6 +35,7 @@ public boolean prettyPrint() { return prettyPrint; } + @Override public void setPrettyPrint(boolean shouldPrettyPrint) { this.prettyPrint = shouldPrettyPrint; } diff --git a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/DefaultReaderConfig.java b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/DefaultReaderConfig.java index 44017fe1ac..fa9c92ec62 100644 --- a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/DefaultReaderConfig.java +++ b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/DefaultReaderConfig.java @@ -5,7 +5,7 @@ import java.util.HashSet; /** - * The ReaderConfig interface defines configuration settings for + * The {@code ReaderConfig} interface defines configuration settings for * JAX-RS annotations reader. */ public class DefaultReaderConfig implements ReaderConfig { diff --git a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/ReaderConfig.java b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/ReaderConfig.java index dcb3e4c600..f37d800fa3 100644 --- a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/ReaderConfig.java +++ b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/ReaderConfig.java @@ -5,7 +5,7 @@ import java.util.Collection; /** - * The ReaderConfig interface defines configuration settings for + * The {@code ReaderConfig} interface defines configuration settings for * JAX-RS annotations reader. */ public interface ReaderConfig { @@ -14,7 +14,7 @@ public interface ReaderConfig { * Checks if all resources, but not those with the * {@link Api} annotation has to be processed. * - * @return true if all resource has to be processed + * @return {@code true} if all resource has to be processed */ boolean isScanAllResources(); diff --git a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/ReaderConfigUtils.java b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/ReaderConfigUtils.java index bbff92c0e8..bf1337497c 100644 --- a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/ReaderConfigUtils.java +++ b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/ReaderConfigUtils.java @@ -8,7 +8,7 @@ import java.util.Set; /** - * The ReaderConfigUtils class defines helper methods for handling + * The {@code ReaderConfigUtils} class defines helper methods for handling * configuration settings for JAX-RS annotations reader. */ public class ReaderConfigUtils { diff --git a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/ReflectiveJaxrsScanner.java b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/ReflectiveJaxrsScanner.java index b35d14dc2f..1a40e121a7 100644 --- a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/ReflectiveJaxrsScanner.java +++ b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/ReflectiveJaxrsScanner.java @@ -59,6 +59,7 @@ public void setResourcePackage(String resourcePackage) { this.resourcePackage = resourcePackage; } + @Override public Swagger configure(Swagger swagger) { if (filterClass != null) { try { @@ -74,6 +75,7 @@ public Swagger configure(Swagger swagger) { return swagger; } + @Override public Set> classes() { Set> classes = getReflections().getTypesAnnotatedWith(Api.class); Set> output = new HashSet>(); @@ -85,6 +87,7 @@ public Set> classes() { return output; } + @Override public String getFilterClass() { return filterClass; } @@ -93,10 +96,12 @@ public void setFilterClass(String filterClass) { this.filterClass = filterClass; } + @Override public boolean getPrettyPrint() { return true; } + @Override public void setPrettyPrint(boolean shouldPrettyPrint) { prettyPrint = shouldPrettyPrint; } diff --git a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/SwaggerContextService.java b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/SwaggerContextService.java index 990f788a08..0cb93734de 100644 --- a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/SwaggerContextService.java +++ b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/SwaggerContextService.java @@ -256,7 +256,7 @@ public static boolean isScannerIdInitParamDefined(ServletConfig sc) { if (key != null){ return true; } else { - return (sc.getInitParameter(CONTEXT_ID_KEY) != null) ? true : false; + return (sc.getInitParameter(CONTEXT_ID_KEY) != null); } } @@ -276,7 +276,7 @@ public static boolean isConfigIdInitParamDefined(ServletConfig sc) { if (key != null){ return true; } else { - return (sc.getInitParameter(CONTEXT_ID_KEY) != null) ? true : false; + return (sc.getInitParameter(CONTEXT_ID_KEY) != null); } } diff --git a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/WebXMLReader.java b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/WebXMLReader.java index 6f47c7c6d2..1efa11c418 100644 --- a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/WebXMLReader.java +++ b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/WebXMLReader.java @@ -14,13 +14,14 @@ import java.util.List; public class WebXMLReader implements SwaggerConfig { - protected String basePath, - host, - filterClass, - apiVersion, - title; + private static final Logger LOGGER = LoggerFactory.getLogger(WebXMLReader.class); + + protected String basePath; + protected String host; + protected String filterClass; + protected String apiVersion; + protected String title; protected String[] schemes = new String[]{}; - private Logger LOGGER = LoggerFactory.getLogger(WebXMLReader.class); public WebXMLReader(ServletConfig servletConfig) { apiVersion = servletConfig.getInitParameter("api.version"); @@ -83,10 +84,12 @@ public WebXMLReader(ServletConfig servletConfig) { } } + @Override public String getFilterClass() { return filterClass; } + @Override public Swagger configure(Swagger swagger) { if (swagger != null) { Info info = swagger.getInfo(); diff --git a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/ext/SwaggerExtensions.java b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/ext/SwaggerExtensions.java index 4e5a4cb569..3e4eccbd36 100644 --- a/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/ext/SwaggerExtensions.java +++ b/modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/ext/SwaggerExtensions.java @@ -10,7 +10,7 @@ import java.util.ServiceLoader; public class SwaggerExtensions { - static Logger LOGGER = LoggerFactory.getLogger(SwaggerExtensions.class); + private static Logger LOGGER = LoggerFactory.getLogger(SwaggerExtensions.class); private static List extensions = null; @@ -29,9 +29,7 @@ public static Iterator chain() { static { extensions = new ArrayList(); ServiceLoader loader = ServiceLoader.load(SwaggerExtension.class); - Iterator itr = loader.iterator(); - while (itr.hasNext()) { - SwaggerExtension ext = itr.next(); + for (SwaggerExtension ext : loader) { LOGGER.debug("adding extension " + ext); extensions.add(ext); } diff --git a/modules/swagger-jaxrs/src/test/java/io/swagger/ApiListingResourceTest.java b/modules/swagger-jaxrs/src/test/java/io/swagger/ApiListingResourceTest.java index f8424e0427..603d14778f 100644 --- a/modules/swagger-jaxrs/src/test/java/io/swagger/ApiListingResourceTest.java +++ b/modules/swagger-jaxrs/src/test/java/io/swagger/ApiListingResourceTest.java @@ -7,13 +7,12 @@ import javax.servlet.ServletConfig; import javax.servlet.ServletContext; - import java.util.Enumeration; import static org.testng.Assert.assertNull; /** - * The ApiListingResourceTest test should confirm that scanning of + * The {@code ApiListingResourceTest} test should confirm that scanning of * the {@link ApiListingResource} class doesn't affect Swagger output. */ public class ApiListingResourceTest { diff --git a/modules/swagger-jaxrs/src/test/java/io/swagger/ReferenceTest.java b/modules/swagger-jaxrs/src/test/java/io/swagger/ReferenceTest.java index 3ad3341979..81506196a8 100644 --- a/modules/swagger-jaxrs/src/test/java/io/swagger/ReferenceTest.java +++ b/modules/swagger-jaxrs/src/test/java/io/swagger/ReferenceTest.java @@ -9,17 +9,12 @@ import io.swagger.models.properties.RefProperty; import io.swagger.resources.ResourceWithReferences; import io.swagger.util.ResourceUtils; - -import org.apache.commons.io.IOUtils; import org.testng.annotations.Test; import java.io.IOException; -import java.io.InputStream; -import java.nio.charset.StandardCharsets; import java.util.Map; import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertTrue; public class ReferenceTest { diff --git a/modules/swagger-jaxrs/src/test/java/io/swagger/SimpleReaderTest.java b/modules/swagger-jaxrs/src/test/java/io/swagger/SimpleReaderTest.java index a9b3192f6f..97f60bc55e 100644 --- a/modules/swagger-jaxrs/src/test/java/io/swagger/SimpleReaderTest.java +++ b/modules/swagger-jaxrs/src/test/java/io/swagger/SimpleReaderTest.java @@ -4,7 +4,6 @@ import com.google.common.base.Functions; import com.google.common.collect.Collections2; import com.google.common.collect.ImmutableMap; - import io.swagger.jaxrs.Reader; import io.swagger.jaxrs.config.DefaultReaderConfig; import io.swagger.models.ArrayModel; @@ -28,9 +27,33 @@ import io.swagger.models.properties.Property; import io.swagger.models.properties.RefProperty; import io.swagger.models.properties.StringProperty; -import io.swagger.resources.*; - -import io.swagger.util.Json; +import io.swagger.resources.ClassWithExamplePost; +import io.swagger.resources.HiddenResource; +import io.swagger.resources.NicknamedOperation; +import io.swagger.resources.Resource1041; +import io.swagger.resources.Resource1073; +import io.swagger.resources.Resource1085; +import io.swagger.resources.Resource653; +import io.swagger.resources.Resource841; +import io.swagger.resources.Resource877; +import io.swagger.resources.Resource937; +import io.swagger.resources.ResourceWithApiOperationCode; +import io.swagger.resources.ResourceWithApiResponseResponseContainer; +import io.swagger.resources.ResourceWithBodyParams; +import io.swagger.resources.ResourceWithCustomHTTPMethodAnnotations; +import io.swagger.resources.ResourceWithEmptyModel; +import io.swagger.resources.ResourceWithEnums; +import io.swagger.resources.ResourceWithInnerClass; +import io.swagger.resources.ResourceWithMapReturnValue; +import io.swagger.resources.ResourceWithRanges; +import io.swagger.resources.ResourceWithResponse; +import io.swagger.resources.ResourceWithResponseHeaders; +import io.swagger.resources.ResourceWithTypedResponses; +import io.swagger.resources.ResourceWithVoidReturns; +import io.swagger.resources.SimpleResource; +import io.swagger.resources.SimpleResourceWithoutAnnotations; +import io.swagger.resources.SimpleSelfReferencingSubResource; +import io.swagger.resources.TaggedResource; import org.testng.annotations.Test; import java.util.ArrayList; @@ -38,13 +61,7 @@ import java.util.List; import java.util.Map; -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertFalse; -import static org.testng.Assert.assertNotEquals; -import static org.testng.Assert.assertNotNull; -import static org.testng.Assert.assertNull; -import static org.testng.Assert.assertTrue; -import static org.testng.Assert.fail; +import static org.testng.Assert.*; public class SimpleReaderTest { @@ -140,7 +157,7 @@ public void scanResourceWithCustomHttpMethodAnnotations() { assertNotNull(patch); Operation put = getPut(swagger, "/"); - assertNotNull(post); + assertNotNull(put); Operation delete = getDelete(swagger, "/"); assertNotNull(delete); diff --git a/modules/swagger-jaxrs/src/test/java/io/swagger/SwaggerConfigLocatorTest.java b/modules/swagger-jaxrs/src/test/java/io/swagger/SwaggerConfigLocatorTest.java index 10a235d3be..2b81d197ad 100644 --- a/modules/swagger-jaxrs/src/test/java/io/swagger/SwaggerConfigLocatorTest.java +++ b/modules/swagger-jaxrs/src/test/java/io/swagger/SwaggerConfigLocatorTest.java @@ -3,7 +3,6 @@ import io.swagger.config.SwaggerConfig; import io.swagger.jaxrs.config.SwaggerConfigLocator; import io.swagger.models.Swagger; -import org.testng.annotations.BeforeClass; import org.testng.annotations.BeforeMethod; import org.testng.annotations.Test; diff --git a/modules/swagger-jaxrs/src/test/java/io/swagger/SwaggerContextServiceTest.java b/modules/swagger-jaxrs/src/test/java/io/swagger/SwaggerContextServiceTest.java index 1853c2975a..20ef7ac89f 100644 --- a/modules/swagger-jaxrs/src/test/java/io/swagger/SwaggerContextServiceTest.java +++ b/modules/swagger-jaxrs/src/test/java/io/swagger/SwaggerContextServiceTest.java @@ -16,33 +16,22 @@ import javax.servlet.ServletConfig; import javax.servlet.ServletContext; -import static io.swagger.jaxrs.config.SwaggerContextService.CONFIG_ID_DEFAULT; -import static io.swagger.jaxrs.config.SwaggerContextService.CONFIG_ID_KEY; -import static io.swagger.jaxrs.config.SwaggerContextService.CONFIG_ID_PREFIX; -import static io.swagger.jaxrs.config.SwaggerContextService.CONTEXT_ID_KEY; -import static io.swagger.jaxrs.config.SwaggerContextService.SCANNER_ID_DEFAULT; -import static io.swagger.jaxrs.config.SwaggerContextService.SCANNER_ID_KEY; -import static io.swagger.jaxrs.config.SwaggerContextService.SCANNER_ID_PREFIX; +import static io.swagger.jaxrs.config.SwaggerContextService.*; import static org.mockito.Matchers.any; import static org.mockito.Matchers.eq; -import static org.mockito.Mockito.mock; -import static org.mockito.Mockito.never; -import static org.mockito.Mockito.times; -import static org.mockito.Mockito.verify; -import static org.mockito.Mockito.when; +import static org.mockito.Mockito.*; import static org.testng.Assert.assertEquals; import static org.testng.Assert.assertNotNull; import static org.testng.Assert.assertTrue; public class SwaggerContextServiceTest { - - ServletContext servletContext1; - ServletConfig servletConfig1; - ServletContext servletContext2; - ServletConfig servletConfig2; - Scanner beanConfigScanner1; - Scanner beanConfigScanner2; - Scanner jaxrsScanner; + private ServletContext servletContext1; + private ServletConfig servletConfig1; + private ServletContext servletContext2; + private ServletConfig servletConfig2; + private Scanner beanConfigScanner1; + private Scanner beanConfigScanner2; + private Scanner jaxrsScanner; @BeforeMethod void initMock() { @@ -55,15 +44,14 @@ void initMock() { BeanConfig bc = new BeanConfig(); bc.setDescription("Bean Config test 1"); - beanConfigScanner1 = (Scanner) bc; + beanConfigScanner1 = bc; bc = new BeanConfig(); bc.setDescription("Bean Config test 2"); - beanConfigScanner2 = (Scanner) bc; + beanConfigScanner2 = bc; } - void stubWithInitParam() { - + private void stubWithInitParam() { when(servletContext1.getAttribute(SCANNER_ID_PREFIX + "test.1")).thenReturn(beanConfigScanner1); when(servletContext2.getAttribute(SCANNER_ID_PREFIX + "test.2")).thenReturn(beanConfigScanner2); @@ -78,8 +66,7 @@ void stubWithInitParam() { } - void stubWithContextInitParam() { - + private void stubWithContextInitParam() { when(servletContext1.getAttribute(SCANNER_ID_PREFIX + "test.1")).thenReturn(beanConfigScanner1); when(servletContext2.getAttribute(SCANNER_ID_PREFIX + "test.2")).thenReturn(beanConfigScanner2); @@ -91,8 +78,7 @@ void stubWithContextInitParam() { } - void stubWithoutInitParam() { - + private void stubWithoutInitParam() { when(servletContext1.getAttribute(SCANNER_ID_DEFAULT)).thenReturn(jaxrsScanner); when(servletContext2.getAttribute(SCANNER_ID_DEFAULT)).thenReturn(jaxrsScanner); @@ -103,7 +89,6 @@ void stubWithoutInitParam() { @Test(description = "should add servletContext attributes SCANNER_ID_PREFIX + \"test.1/2") public void initializeScannerWithInitParam() { - stubWithInitParam(); new SwaggerContextService().withServletConfig(servletConfig1).initScanner(); @@ -121,7 +106,6 @@ public void initializeScannerWithInitParam() { @Test(description = "should call servletContext getAttribute with param SCANNER_ID_PREFIX + \"test.1/2\"") public void getScannerWithInitParam() { - stubWithInitParam(); Scanner scanner1 = new SwaggerContextService().withServletConfig(servletConfig1).getScanner(); @@ -129,7 +113,6 @@ public void getScannerWithInitParam() { assertEquals(beanConfigScanner1, scanner1); assertEquals(beanConfigScanner2, scanner2); - ; verify(servletConfig1, times(2)).getInitParameter(eq(SCANNER_ID_KEY)); verify(servletContext1, times(1)).getAttribute(eq(SCANNER_ID_PREFIX + "test.1")); @@ -143,7 +126,6 @@ public void getScannerWithInitParam() { @Test(description = "should add servletContext attributes SCANNER_ID_PREFIX + \"test.1/2") public void initializeScannerWithContextInitParam() { - stubWithContextInitParam(); new SwaggerContextService().withServletConfig(servletConfig1).initScanner(); @@ -163,7 +145,6 @@ public void initializeScannerWithContextInitParam() { @Test(description = "should call servletContext getAttribute with param SCANNER_ID_PREFIX + \"test.1/2\"") public void getScannerWithContextInitParam() { - stubWithContextInitParam(); Scanner scanner1 = new SwaggerContextService().withServletConfig(servletConfig1).getScanner(); @@ -171,7 +152,6 @@ public void getScannerWithContextInitParam() { assertEquals(beanConfigScanner1, scanner1); assertEquals(beanConfigScanner2, scanner2); - ; verify(servletConfig1, times(1)).getInitParameter(eq(SCANNER_ID_KEY)); verify(servletConfig1, times(2)).getInitParameter(eq(CONTEXT_ID_KEY)); @@ -187,7 +167,6 @@ public void getScannerWithContextInitParam() { @Test(description = "should add servletContext attributes SCANNER_ID_DEFAULT") public void initializeAndGetScannerWithoutInitParam() { - stubWithoutInitParam(); new SwaggerContextService().withServletConfig(servletConfig1).initScanner(); new SwaggerContextService().withServletConfig(servletConfig2).initScanner(); @@ -206,7 +185,6 @@ public void initializeAndGetScannerWithoutInitParam() { @Test(description = "should add scanner to ScannerFactory") public void initializeAndGetScannerWithoutServletConfig() { - new SwaggerContextService().initScanner(); new SwaggerContextService().initScanner(); @@ -227,7 +205,6 @@ public void initializeAndGetScannerWithoutServletConfig() { @Test(description = "should add SwaggerConfig to SwaggerConfigLocator map with key CONFIG_ID_PREFIX + \"test.1/2\"") public void initializeAndGetConfigWithInitParam() { - stubWithInitParam(); new SwaggerContextService().withServletConfig(servletConfig1).initConfig(); @@ -243,7 +220,6 @@ public void initializeAndGetConfigWithInitParam() { @Test(description = "should add SwaggerConfig to SwaggerConfigLocator map with key CONFIG_ID_PREFIX + \"test.1/2\"") public void initializeAndGetConfigWithContextInitParam() { - stubWithContextInitParam(); new SwaggerContextService().withServletConfig(servletConfig1).initConfig(); @@ -261,7 +237,6 @@ public void initializeAndGetConfigWithContextInitParam() { @Test(description = "should add SwaggerConfig to SwaggerConfigLocator map with key CONFIG_ID_DEFAULT") public void initializeAndGetConfigWithoutInitParam() { - stubWithoutInitParam(); new SwaggerContextService().withServletConfig(servletConfig1).initConfig(); @@ -274,7 +249,6 @@ public void initializeAndGetConfigWithoutInitParam() { @Test(description = "should add SwaggerConfig to SwaggerConfigLocator map with key CONFIG_ID_DEFAULT") public void initializeAndGetConfigWithoutServletConfig() { - new SwaggerContextService().initConfig(); new SwaggerContextService().initConfig(); @@ -283,8 +257,7 @@ public void initializeAndGetConfigWithoutServletConfig() { } - void stubWithContextSwaggerAttribute() { - + private void stubWithContextSwaggerAttribute() { Swagger swagger = new Swagger(); Info info = new Info().title("Test Title"); swagger.setInfo(info); @@ -295,12 +268,10 @@ void stubWithContextSwaggerAttribute() { when(servletConfig1.getInitParameter(CONTEXT_ID_KEY)).thenReturn("test.1"); when(servletConfig2.getInitParameter(CONTEXT_ID_KEY)).thenReturn("test.2"); - } @Test(description = "should get correct swagger context set via context param \"swagger\"") public void initConfigViaContextParamSwagger() { - stubWithContextSwaggerAttribute(); Swagger swagger = new SwaggerContextService().withServletConfig(servletConfig1).getSwagger(); diff --git a/modules/swagger-jaxrs/src/test/java/io/swagger/functional/test/ApiListingResourceIT.java b/modules/swagger-jaxrs/src/test/java/io/swagger/functional/test/ApiListingResourceIT.java index 7bcd10c22f..f7aef0c24d 100644 --- a/modules/swagger-jaxrs/src/test/java/io/swagger/functional/test/ApiListingResourceIT.java +++ b/modules/swagger-jaxrs/src/test/java/io/swagger/functional/test/ApiListingResourceIT.java @@ -1,21 +1,55 @@ package io.swagger.functional.test; import com.jayway.restassured.http.ContentType; -import com.jayway.restassured.response.ValidatableResponse; import org.testng.annotations.Test; import static com.jayway.restassured.RestAssured.given; -import static org.hamcrest.CoreMatchers.equalTo; import static org.testng.Assert.assertEquals; /** * Created by rbolles on 2/16/16. - * + *

* An functional integration test that runs during maven's integration-test phase, * uses RestAssured to define REST API tests, and Jetty's Maven plugin to serve a simple * sample app just prior to the integration-test phase starting. */ public class ApiListingResourceIT { + private static final String EXPECTED_JSON = "{\"swagger\":\"2.0\",\"tags\":[{\"name\":\"widgets\"}],\"paths\":{\"/widgets/{widgetId}\":{\"get\":{\"tags\":[\"widgets\"],\"summary\":\"Find pet by ID\",\"description\":\"Returns a pet when ID <= 10. ID > 10 or nonintegers will simulate API error conditions\",\"operationId\":\"getWidget\",\"consumes\":[\"application/json\"],\"produces\":[\"application/json\"],\"parameters\":[{\"name\":\"widgetId\",\"in\":\"path\",\"required\":true,\"type\":\"string\"}],\"responses\":{\"200\":{\"description\":\"Returns widget with matching id\"}}}}},\"definitions\":{\"Widget\":{\"type\":\"object\",\"properties\":{\"a\":{\"type\":\"string\"},\"b\":{\"type\":\"string\"},\"id\":{\"type\":\"string\"}}}}}"; + private static final String EXPECTED_YAML = "---\n" + + "swagger: \"2.0\"\n" + + "tags:\n" + + "- name: \"widgets\"\n" + + "paths:\n" + + " /widgets/{widgetId}:\n" + + " get:\n" + + " tags:\n" + + " - \"widgets\"\n" + + " summary: \"Find pet by ID\"\n" + + " description: \"Returns a pet when ID <= 10. ID > 10 or nonintegers will simulate\\\n" + + " \\ API error conditions\"\n" + + " operationId: \"getWidget\"\n" + + " consumes:\n" + + " - \"application/json\"\n" + + " produces:\n" + + " - \"application/json\"\n" + + " parameters:\n" + + " - name: \"widgetId\"\n" + + " in: \"path\"\n" + + " required: true\n" + + " type: \"string\"\n" + + " responses:\n" + + " 200:\n" + + " description: \"Returns widget with matching id\"\n" + + "definitions:\n" + + " Widget:\n" + + " type: \"object\"\n" + + " properties:\n" + + " a:\n" + + " type: \"string\"\n" + + " b:\n" + + " type: \"string\"\n" + + " id:\n" + + " type: \"string\"\n"; @Test public void testSwaggerJson() throws Exception { @@ -65,7 +99,6 @@ public void testSwaggerYaml() throws Exception { .extract().response().body().asString(); assertEquals(actualBody, EXPECTED_YAML); - } @Test @@ -84,43 +117,4 @@ public void testSwaggerYamlUsingAcceptHeader() throws Exception { assertEquals(actualBody, EXPECTED_YAML); } - - - - public static final String EXPECTED_JSON = "{\"swagger\":\"2.0\",\"tags\":[{\"name\":\"widgets\"}],\"paths\":{\"/widgets/{widgetId}\":{\"get\":{\"tags\":[\"widgets\"],\"summary\":\"Find pet by ID\",\"description\":\"Returns a pet when ID <= 10. ID > 10 or nonintegers will simulate API error conditions\",\"operationId\":\"getWidget\",\"consumes\":[\"application/json\"],\"produces\":[\"application/json\"],\"parameters\":[{\"name\":\"widgetId\",\"in\":\"path\",\"required\":true,\"type\":\"string\"}],\"responses\":{\"200\":{\"description\":\"Returns widget with matching id\"}}}}},\"definitions\":{\"Widget\":{\"type\":\"object\",\"properties\":{\"a\":{\"type\":\"string\"},\"b\":{\"type\":\"string\"},\"id\":{\"type\":\"string\"}}}}}"; - public static final String EXPECTED_YAML = "---\n" + - "swagger: \"2.0\"\n" + - "tags:\n" + - "- name: \"widgets\"\n" + - "paths:\n" + - " /widgets/{widgetId}:\n" + - " get:\n" + - " tags:\n" + - " - \"widgets\"\n" + - " summary: \"Find pet by ID\"\n" + - " description: \"Returns a pet when ID <= 10. ID > 10 or nonintegers will simulate\\\n" + - " \\ API error conditions\"\n" + - " operationId: \"getWidget\"\n" + - " consumes:\n" + - " - \"application/json\"\n" + - " produces:\n" + - " - \"application/json\"\n" + - " parameters:\n" + - " - name: \"widgetId\"\n" + - " in: \"path\"\n" + - " required: true\n" + - " type: \"string\"\n" + - " responses:\n" + - " 200:\n" + - " description: \"Returns widget with matching id\"\n" + - "definitions:\n" + - " Widget:\n" + - " type: \"object\"\n" + - " properties:\n" + - " a:\n" + - " type: \"string\"\n" + - " b:\n" + - " type: \"string\"\n" + - " id:\n" + - " type: \"string\"\n"; } diff --git a/modules/swagger-jaxrs/src/test/java/io/swagger/models/TestEnum.java b/modules/swagger-jaxrs/src/test/java/io/swagger/models/TestEnum.java index 167d977d0b..fc9db1aa0e 100644 --- a/modules/swagger-jaxrs/src/test/java/io/swagger/models/TestEnum.java +++ b/modules/swagger-jaxrs/src/test/java/io/swagger/models/TestEnum.java @@ -1,5 +1,5 @@ package io.swagger.models; public enum TestEnum { - ONE, TWO, THREE; + ONE, TWO, THREE } diff --git a/modules/swagger-jaxrs/src/test/java/io/swagger/resources/AnnotatedInterfaceImpl.java b/modules/swagger-jaxrs/src/test/java/io/swagger/resources/AnnotatedInterfaceImpl.java index cec5eae0ab..766199213b 100644 --- a/modules/swagger-jaxrs/src/test/java/io/swagger/resources/AnnotatedInterfaceImpl.java +++ b/modules/swagger-jaxrs/src/test/java/io/swagger/resources/AnnotatedInterfaceImpl.java @@ -3,8 +3,6 @@ import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; -import javax.ws.rs.Path; - @Api(value = "/v1/users", tags = "annotatedInterface") public class AnnotatedInterfaceImpl implements AnnotatedInterface { diff --git a/modules/swagger-jaxrs/src/test/java/io/swagger/resources/BookResource.java b/modules/swagger-jaxrs/src/test/java/io/swagger/resources/BookResource.java index d2f2c5e016..3a994a0929 100644 --- a/modules/swagger-jaxrs/src/test/java/io/swagger/resources/BookResource.java +++ b/modules/swagger-jaxrs/src/test/java/io/swagger/resources/BookResource.java @@ -19,10 +19,12 @@ public class BookResource extends BaseResource { @PathParam("description") private String description = "Overriden"; + @Override public String getDescription() { return description; } + @Override public void setDescription(String description) { this.description = description; } diff --git a/modules/swagger-jaxrs/src/test/java/io/swagger/resources/NoPathSubResource.java b/modules/swagger-jaxrs/src/test/java/io/swagger/resources/NoPathSubResource.java index 146a8c6899..9090e8ad21 100644 --- a/modules/swagger-jaxrs/src/test/java/io/swagger/resources/NoPathSubResource.java +++ b/modules/swagger-jaxrs/src/test/java/io/swagger/resources/NoPathSubResource.java @@ -6,7 +6,7 @@ import javax.ws.rs.GET; /** - * The NoPathSubResource class defines test sub-resource without + * The {@code NoPathSubResource} class defines test sub-resource without * {@link javax.ws.rs.Path} annotations. */ @Api() diff --git a/modules/swagger-jaxrs/src/test/java/io/swagger/resources/ResourceWithCustomHTTPMethodAnnotations.java b/modules/swagger-jaxrs/src/test/java/io/swagger/resources/ResourceWithCustomHTTPMethodAnnotations.java index b6327648d6..1496575bbc 100644 --- a/modules/swagger-jaxrs/src/test/java/io/swagger/resources/ResourceWithCustomHTTPMethodAnnotations.java +++ b/modules/swagger-jaxrs/src/test/java/io/swagger/resources/ResourceWithCustomHTTPMethodAnnotations.java @@ -1,9 +1,10 @@ package io.swagger.resources; -import io.swagger.annotations.*; -import io.swagger.models.NotFoundModel; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; -import javax.ws.rs.*; +import javax.ws.rs.HttpMethod; +import javax.ws.rs.Path; import javax.ws.rs.core.Response; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; diff --git a/modules/swagger-jaxrs/src/test/java/io/swagger/resources/ResourceWithSubResources.java b/modules/swagger-jaxrs/src/test/java/io/swagger/resources/ResourceWithSubResources.java index ddcdee7615..9fff9bf55b 100644 --- a/modules/swagger-jaxrs/src/test/java/io/swagger/resources/ResourceWithSubResources.java +++ b/modules/swagger-jaxrs/src/test/java/io/swagger/resources/ResourceWithSubResources.java @@ -4,7 +4,6 @@ import io.swagger.annotations.ApiOperation; import io.swagger.models.Employee; -import javax.ws.rs.GET; import javax.ws.rs.Path; @Api("/employees") diff --git a/modules/swagger-jaxrs/src/test/java/io/swagger/resources/SubResourceHead.java b/modules/swagger-jaxrs/src/test/java/io/swagger/resources/SubResourceHead.java index 982ea63c74..ef12dc2fc8 100644 --- a/modules/swagger-jaxrs/src/test/java/io/swagger/resources/SubResourceHead.java +++ b/modules/swagger-jaxrs/src/test/java/io/swagger/resources/SubResourceHead.java @@ -47,7 +47,7 @@ public Class getStringClass() { * This path is expected to be skipped by * {@link Reader} as resource class is unknown here. * - * @return null + * @return {@code null} */ @Path("anyClass") public Class getAnyClass() { @@ -58,7 +58,7 @@ public Class getAnyClass() { * This path is expected to be skipped by * {@link Reader} as resource class is unknown here. * - * @return null + * @return {@code null} */ @Path("wildcardClass") public Class getWildcardClass() { @@ -69,7 +69,7 @@ public Class getWildcardClass() { * This path is expected to be skipped by * {@link Reader} as method result is an array. * - * @return null + * @return {@code null} */ @Path("classes") public Class[] getClasses() {