io.swagger.jaxrs.ext

Class AbstractSwaggerExtension

java.lang.Object

io.swagger.jaxrs.ext.AbstractSwaggerExtension

All Implemented Interfaces:

SwaggerExtension

Direct Known Subclasses:

DefaultParameterExtension

public abstract class AbstractSwaggerExtension
extends Object
implements SwaggerExtension

Constructor Summary

Constructors

Constructor and Description
AbstractSwaggerExtension()

Method Summary

Modifier and Type	Method and Description
protected com.fasterxml.jackson.databind.JavaType	constructType(Type type)
void	decorateOperation(Operation operation, Method method, Iterator<SwaggerExtension> chain) Decorates operation with additional vendor based extensions.
String	extractOperationMethod(ApiOperation apiOperation, Method method, Iterator<SwaggerExtension> chain)
List<Parameter>	extractParameters(List<Annotation> annotations, Type type, Set<Type> typesToSkip, Iterator<SwaggerExtension> chain)
protected boolean	shouldIgnoreClass(Class<?> cls)
protected boolean	shouldIgnoreType(Type type, Set<Type> typesToSkip)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSwaggerExtension

public AbstractSwaggerExtension()

Method Detail

extractOperationMethod

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

Specified by:

extractOperationMethod in interface SwaggerExtension

extractParameters

public List<Parameter> extractParameters(List<Annotation> annotations,
                                         Type type,
                                         Set<Type> typesToSkip,
                                         Iterator<SwaggerExtension> chain)

Specified by:

extractParameters in interface SwaggerExtension

decorateOperation

public void decorateOperation(Operation operation,
                              Method method,
                              Iterator<SwaggerExtension> chain)

Description copied from interface: SwaggerExtension

Decorates operation with additional vendor based extensions.

Specified by:

decorateOperation in interface SwaggerExtension

Parameters:

operation - the operation, build from swagger definition

method - the method for additional scan

chain - the chain with swagger extensions to process

shouldIgnoreClass

protected boolean shouldIgnoreClass(Class<?> cls)

shouldIgnoreType

protected boolean shouldIgnoreType(Type type,
                                   Set<Type> typesToSkip)

constructType

protected com.fasterxml.jackson.databind.JavaType constructType(Type type)