Package io.swagger.v3.jaxrs2.ext

Class AbstractOpenAPIExtension

java.lang.Object

io.swagger.v3.jaxrs2.ext.AbstractOpenAPIExtension

All Implemented Interfaces:

OpenAPIExtension

Direct Known Subclasses:

DefaultParameterExtension

public abstract class AbstractOpenAPIExtension
extends Object
implements OpenAPIExtension

Field Summary

Fields

Modifier and Type	Field	Description
protected io.swagger.v3.core.util.Configuration	configuration
protected boolean	openapi31
protected io.swagger.v3.oas.models.media.Schema.SchemaResolution	schemaResolution

Constructor Summary

Constructors

Constructor	Description
AbstractOpenAPIExtension()

Method Summary

Modifier and Type	Method	Description
protected com.fasterxml.jackson.databind.JavaType	constructType(Type type)
void	decorateOperation(io.swagger.v3.oas.models.Operation operation, Method method, Iterator<OpenAPIExtension> chain)	Decorates operation with additional vendor based extensions.
String	extractOperationMethod(Method method, Iterator<OpenAPIExtension> chain)
ResolvedParameter	extractParameters(List<Annotation> annotations, Type type, Set<Type> typesToSkip, io.swagger.v3.oas.models.Components components, javax.ws.rs.Consumes classConsumes, javax.ws.rs.Consumes methodConsumes, boolean includeRequestBody, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, Iterator<OpenAPIExtension> chain)
void	setConfiguration(io.swagger.v3.core.util.Configuration configuration)
void	setOpenAPI31(boolean openapi31)
void	setSchemaResolution(io.swagger.v3.oas.models.media.Schema.SchemaResolution schemaResolution)
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

Field Detail

openapi31

protected boolean openapi31

schemaResolution

protected io.swagger.v3.oas.models.media.Schema.SchemaResolution schemaResolution

configuration

protected io.swagger.v3.core.util.Configuration configuration

Constructor Detail

AbstractOpenAPIExtension

public AbstractOpenAPIExtension()

Method Detail

extractOperationMethod

public String extractOperationMethod(Method method,
                                     Iterator<OpenAPIExtension> chain)

Specified by:

extractOperationMethod in interface OpenAPIExtension

extractParameters

public ResolvedParameter extractParameters(List<Annotation> annotations,
                                           Type type,
                                           Set<Type> typesToSkip,
                                           io.swagger.v3.oas.models.Components components,
                                           javax.ws.rs.Consumes classConsumes,
                                           javax.ws.rs.Consumes methodConsumes,
                                           boolean includeRequestBody,
                                           com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                           Iterator<OpenAPIExtension> chain)

Specified by:

extractParameters in interface OpenAPIExtension

decorateOperation

public void decorateOperation(io.swagger.v3.oas.models.Operation operation,
                              Method method,
                              Iterator<OpenAPIExtension> chain)

Description copied from interface: OpenAPIExtension

Decorates operation with additional vendor based extensions.

Specified by:

decorateOperation in interface OpenAPIExtension

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)

setOpenAPI31

public void setOpenAPI31(boolean openapi31)

Specified by:

setOpenAPI31 in interface OpenAPIExtension

setSchemaResolution

public void setSchemaResolution(io.swagger.v3.oas.models.media.Schema.SchemaResolution schemaResolution)

Specified by:

setSchemaResolution in interface OpenAPIExtension

setConfiguration

public void setConfiguration(io.swagger.v3.core.util.Configuration configuration)

Specified by:

setConfiguration in interface OpenAPIExtension