Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
123 changes: 54 additions & 69 deletions modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/Reader.java

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -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;
Expand All @@ -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());

Expand Down Expand Up @@ -140,6 +139,7 @@ public void setHost(String host) {
this.host = host;
}

@Override
public String getFilterClass() {
return filterClass;
}
Expand Down Expand Up @@ -233,6 +233,7 @@ public void scanAndRead() {
}
}

@Override
public Set<Class<?>> classes() {
ConfigurationBuilder config = new ConfigurationBuilder();
Set<String> acceptablePackages = new HashSet<String>();
Expand Down Expand Up @@ -316,6 +317,7 @@ public Swagger getSwagger() {
return reader.getSwagger();
}

@Override
public Swagger configure(Swagger swagger) {
if (schemes != null) {
for (String scheme : schemes) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
public class DefaultJaxrsScanner extends AbstractScanner implements JaxrsScanner {
private boolean prettyPrint = false;

@Override
public Set<Class<?>> classesFromContext(Application app, ServletConfig sc) {
Set<Class<?>> output = new HashSet<Class<?>>();
if (app != null) {
Expand All @@ -25,6 +26,7 @@ public Set<Class<?>> classesFromContext(Application app, ServletConfig sc) {
return output;
}

@Override
public Set<Class<?>> classes() {
return new HashSet<Class<?>>();
}
Expand All @@ -33,6 +35,7 @@ public boolean prettyPrint() {
return prettyPrint;
}

@Override
public void setPrettyPrint(boolean shouldPrettyPrint) {
this.prettyPrint = shouldPrettyPrint;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import java.util.HashSet;

/**
* The <code>ReaderConfig</code> interface defines configuration settings for
* The {@code ReaderConfig} interface defines configuration settings for
* JAX-RS annotations reader.
*/
public class DefaultReaderConfig implements ReaderConfig {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import java.util.Collection;

/**
* The <code>ReaderConfig</code> interface defines configuration settings for
* The {@code ReaderConfig} interface defines configuration settings for
* JAX-RS annotations reader.
*/
public interface ReaderConfig {
Expand All @@ -14,7 +14,7 @@ public interface ReaderConfig {
* Checks if all resources, but not those with the
* {@link Api} annotation has to be processed.
*
* @return <code>true</code> if all resource has to be processed
* @return {@code true} if all resource has to be processed
*/
boolean isScanAllResources();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import java.util.Set;

/**
* The <code>ReaderConfigUtils</code> 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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ public void setResourcePackage(String resourcePackage) {
this.resourcePackage = resourcePackage;
}

@Override
public Swagger configure(Swagger swagger) {
if (filterClass != null) {
try {
Expand All @@ -74,6 +75,7 @@ public Swagger configure(Swagger swagger) {
return swagger;
}

@Override
public Set<Class<?>> classes() {
Set<Class<?>> classes = getReflections().getTypesAnnotatedWith(Api.class);
Set<Class<?>> output = new HashSet<Class<?>>();
Expand All @@ -85,6 +87,7 @@ public Set<Class<?>> classes() {
return output;
}

@Override
public String getFilterClass() {
return filterClass;
}
Expand All @@ -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;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
}

Expand All @@ -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);
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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");
Expand Down Expand Up @@ -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();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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<SwaggerExtension> extensions = null;

Expand All @@ -29,9 +29,7 @@ public static Iterator<SwaggerExtension> chain() {
static {
extensions = new ArrayList<SwaggerExtension>();
ServiceLoader<SwaggerExtension> loader = ServiceLoader.load(SwaggerExtension.class);
Iterator<SwaggerExtension> itr = loader.iterator();
while (itr.hasNext()) {
SwaggerExtension ext = itr.next();
for (SwaggerExtension ext : loader) {
LOGGER.debug("adding extension " + ext);
extensions.add(ext);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,12 @@

import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;

import java.util.Enumeration;

import static org.testng.Assert.assertNull;

/**
* The <code>ApiListingResourceTest</code> 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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -28,23 +27,41 @@
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;
import java.util.Arrays;
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 {

Expand Down Expand Up @@ -140,7 +157,7 @@ public void scanResourceWithCustomHttpMethodAnnotations() {
assertNotNull(patch);

Operation put = getPut(swagger, "/");
assertNotNull(post);
assertNotNull(put);

Operation delete = getDelete(swagger, "/");
assertNotNull(delete);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
Loading