io.swagger.jaxrs

Class Reader

java.lang.Object

io.swagger.jaxrs.Reader

public class Reader
extends Object

Constructor Summary

Constructors

Constructor and Description
Reader(Swagger swagger)
Reader(Swagger swagger, ReaderConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
String	extractOperationMethod(ApiOperation apiOperation, Method method, Iterator<SwaggerExtension> chain)
protected Set<String>	extractTags(Api api)
ReaderConfig	getConfig()
protected String	getOperationId(String operationId)
protected Class<?>	getSubResource(Method method)
protected Class<?>	getSubResourceWithJaxRsSubresourceLocatorSpecs(Method method)
Swagger	getSwagger()
Operation	parseMethod(Method method)
Swagger	read(Class<?> cls) Scans a single class for Swagger annotations - does not invoke ReaderListeners
protected Swagger	read(Class<?> cls, String parentPath, String parentMethod, boolean isSubresource, String[] parentConsumes, String[] parentProduces, Map<String,Tag> parentTags, List<Parameter> parentParameters)
Swagger	read(Set<Class<?>> classes) Scans a set of classes for both ReaderListeners and Swagger annotations.
protected Parameter	readImplicitParam(ApiImplicitParam param)
protected void	readInfoConfig(SwaggerDefinition config)
protected void	readSwaggerConfig(Class<?> cls, SwaggerDefinition config)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Reader

public Reader(Swagger swagger)

Reader

public Reader(Swagger swagger,
      ReaderConfig config)

Method Detail

getSwagger

public Swagger getSwagger()

read

public Swagger read(Set<Class<?>> classes)

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 accordingly.

Parameters:

classes - a set of classes to scan

Returns:

the generated Swagger definition

read

public Swagger read(Class<?> cls)

Scans a single class for Swagger annotations - does not invoke ReaderListeners

read

protected Swagger read(Class<?> cls,
           String parentPath,
           String parentMethod,
           boolean isSubresource,
           String[] parentConsumes,
           String[] parentProduces,
           Map<String,Tag> parentTags,
           List<Parameter> parentParameters)

readImplicitParam

protected Parameter readImplicitParam(ApiImplicitParam param)

readSwaggerConfig

protected void readSwaggerConfig(Class<?> cls,
                     SwaggerDefinition config)

readInfoConfig

protected void readInfoConfig(SwaggerDefinition config)

getSubResource

protected Class<?> getSubResource(Method method)

getSubResourceWithJaxRsSubresourceLocatorSpecs

protected Class<?> getSubResourceWithJaxRsSubresourceLocatorSpecs(Method method)

extractTags

protected Set<String> extractTags(Api api)

parseMethod

public Operation parseMethod(Method method)

extractOperationMethod

public String extractOperationMethod(ApiOperation apiOperation,
                            Method method,
                            Iterator<SwaggerExtension> chain)

getConfig

public ReaderConfig getConfig()

getOperationId

protected String getOperationId(String operationId)