io.swagger.v3.jaxrs2

Class Reader

java.lang.Object

io.swagger.v3.jaxrs2.Reader

All Implemented Interfaces:

OpenApiReader

public class Reader
extends Object
implements OpenApiReader

Field Summary

Fields

Modifier and Type	Field and Description
protected OpenAPIConfiguration	config
static String	DEFAULT_DESCRIPTION
static String	DEFAULT_MEDIA_TYPE_VALUE

Constructor Summary

Constructors

Constructor and Description
Reader()
Reader(OpenAPI openAPI)
Reader(OpenAPIConfiguration openApiConfiguration)

Method Summary

Modifier and Type	Method and Description
OpenAPI	getOpenAPI()
protected String	getOperationId(String operationId)
protected ResolvedParameter	getParameters(Type type, List<Annotation> annotations, Operation operation, javax.ws.rs.Consumes classConsumes, javax.ws.rs.Consumes methodConsumes, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
protected Optional<List<Parameter>>	getParametersListFromAnnotation(Parameter[] parameters, javax.ws.rs.Consumes classConsumes, javax.ws.rs.Consumes methodConsumes, Operation operation, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
protected Class<?>	getSubResourceWithJaxRsSubresourceLocatorSpecs(Method method)
protected boolean	ignoreOperationPath(String path, String parentPath)
protected boolean	ignoreOperationPathStrict(String path, String parentPath)
protected boolean	isMethodOverridden(Method method, Class<?> cls)
protected boolean	isOperationHidden(Method method)
protected Operation	parseMethod(Class<?> cls, Method method, List<Parameter> globalParameters, javax.ws.rs.Produces methodProduces, javax.ws.rs.Produces classProduces, javax.ws.rs.Consumes methodConsumes, javax.ws.rs.Consumes classConsumes, List<SecurityRequirement> classSecurityRequirements, Optional<ExternalDocumentation> classExternalDocs, Set<String> classTags, List<Server> classServers, boolean isSubresource, RequestBody parentRequestBody, ApiResponses parentResponses, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, ApiResponse[] classResponses, com.fasterxml.jackson.databind.introspect.AnnotatedMethod annotatedMethod)
Operation	parseMethod(Method method, List<Parameter> globalParameters, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
Operation	parseMethod(Method method, List<Parameter> globalParameters, javax.ws.rs.Produces methodProduces, javax.ws.rs.Produces classProduces, javax.ws.rs.Consumes methodConsumes, javax.ws.rs.Consumes classConsumes, List<SecurityRequirement> classSecurityRequirements, Optional<ExternalDocumentation> classExternalDocs, Set<String> classTags, List<Server> classServers, boolean isSubresource, RequestBody parentRequestBody, ApiResponses parentResponses, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, ApiResponse[] classResponses)
Operation	parseMethod(Method method, List<Parameter> globalParameters, javax.ws.rs.Produces methodProduces, javax.ws.rs.Produces classProduces, javax.ws.rs.Consumes methodConsumes, javax.ws.rs.Consumes classConsumes, List<SecurityRequirement> classSecurityRequirements, Optional<ExternalDocumentation> classExternalDocs, Set<String> classTags, List<Server> classServers, boolean isSubresource, RequestBody parentRequestBody, ApiResponses parentResponses, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, ApiResponse[] classResponses, com.fasterxml.jackson.databind.introspect.AnnotatedMethod annotatedMethod)
protected Content	processContent(Content content, Schema schema, javax.ws.rs.Consumes methodConsumes, javax.ws.rs.Consumes classConsumes)
protected void	processRequestBody(Parameter requestBodyParameter, Operation operation, javax.ws.rs.Consumes methodConsumes, javax.ws.rs.Consumes classConsumes, List<Parameter> operationParameters, Annotation[] paramAnnotations, Type type, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, Map<String,Encoding> encoding)
OpenAPI	read(Class<?> cls) Scans a single class for Swagger annotations - does not invoke ReaderListeners
OpenAPI	read(Class<?> cls, String parentPath, String parentMethod, boolean isSubresource, RequestBody parentRequestBody, ApiResponses parentResponses, Set<String> parentTags, List<Parameter> parentParameters, Set<Class<?>> scannedResources)
OpenAPI	read(Set<Class<?>> classes) Scans a set of classes for both ReaderListeners and OpenAPI annotations.
OpenAPI	read(Set<Class<?>> classes, Map<String,Object> resources)
protected String	resolveApplicationPath()
protected Content	resolveEmptyContent(javax.ws.rs.Produces classProduces, javax.ws.rs.Produces methodProduces)
protected void	resolveResponseSchemaFromReturnType(Operation operation, ApiResponse[] responses, Schema schema, javax.ws.rs.Produces classProduces, javax.ws.rs.Produces methodProduces)
void	setApplication(javax.ws.rs.core.Application application)
void	setConfiguration(OpenAPIConfiguration openApiConfiguration)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MEDIA_TYPE_VALUE

public static final String DEFAULT_MEDIA_TYPE_VALUE

See Also:

Constant Field Values

DEFAULT_DESCRIPTION

public static final String DEFAULT_DESCRIPTION

See Also:

Constant Field Values

config

protected OpenAPIConfiguration config

Constructor Detail

Reader

public Reader()

Reader

public Reader(OpenAPI openAPI)

Reader

public Reader(OpenAPIConfiguration openApiConfiguration)

Method Detail

getOpenAPI

public OpenAPI getOpenAPI()

read

public OpenAPI read(Class<?> cls)

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

read

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

Scans a set of classes for both ReaderListeners and OpenAPI annotations. All found listeners will be instantiated before any of the classes are scanned for OpenAPI annotations - so they can be invoked accordingly.

Parameters:

classes - a set of classes to scan

Returns:

the generated OpenAPI definition

setConfiguration

public void setConfiguration(OpenAPIConfiguration openApiConfiguration)

Specified by:

setConfiguration in interface OpenApiReader

read

public OpenAPI read(Set<Class<?>> classes,
                    Map<String,Object> resources)

Specified by:

read in interface OpenApiReader

resolveApplicationPath

protected String resolveApplicationPath()

read

public OpenAPI read(Class<?> cls,
                    String parentPath,
                    String parentMethod,
                    boolean isSubresource,
                    RequestBody parentRequestBody,
                    ApiResponses parentResponses,
                    Set<String> parentTags,
                    List<Parameter> parentParameters,
                    Set<Class<?>> scannedResources)

processContent

protected Content processContent(Content content,
                                 Schema schema,
                                 javax.ws.rs.Consumes methodConsumes,
                                 javax.ws.rs.Consumes classConsumes)

processRequestBody

protected void processRequestBody(Parameter requestBodyParameter,
                                  Operation operation,
                                  javax.ws.rs.Consumes methodConsumes,
                                  javax.ws.rs.Consumes classConsumes,
                                  List<Parameter> operationParameters,
                                  Annotation[] paramAnnotations,
                                  Type type,
                                  com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                  Map<String,Encoding> encoding)

parseMethod

public Operation parseMethod(Method method,
                             List<Parameter> globalParameters,
                             com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

parseMethod

public Operation parseMethod(Method method,
                             List<Parameter> globalParameters,
                             javax.ws.rs.Produces methodProduces,
                             javax.ws.rs.Produces classProduces,
                             javax.ws.rs.Consumes methodConsumes,
                             javax.ws.rs.Consumes classConsumes,
                             List<SecurityRequirement> classSecurityRequirements,
                             Optional<ExternalDocumentation> classExternalDocs,
                             Set<String> classTags,
                             List<Server> classServers,
                             boolean isSubresource,
                             RequestBody parentRequestBody,
                             ApiResponses parentResponses,
                             com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                             ApiResponse[] classResponses)

parseMethod

public Operation parseMethod(Method method,
                             List<Parameter> globalParameters,
                             javax.ws.rs.Produces methodProduces,
                             javax.ws.rs.Produces classProduces,
                             javax.ws.rs.Consumes methodConsumes,
                             javax.ws.rs.Consumes classConsumes,
                             List<SecurityRequirement> classSecurityRequirements,
                             Optional<ExternalDocumentation> classExternalDocs,
                             Set<String> classTags,
                             List<Server> classServers,
                             boolean isSubresource,
                             RequestBody parentRequestBody,
                             ApiResponses parentResponses,
                             com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                             ApiResponse[] classResponses,
                             com.fasterxml.jackson.databind.introspect.AnnotatedMethod annotatedMethod)

parseMethod

protected Operation parseMethod(Class<?> cls,
                                Method method,
                                List<Parameter> globalParameters,
                                javax.ws.rs.Produces methodProduces,
                                javax.ws.rs.Produces classProduces,
                                javax.ws.rs.Consumes methodConsumes,
                                javax.ws.rs.Consumes classConsumes,
                                List<SecurityRequirement> classSecurityRequirements,
                                Optional<ExternalDocumentation> classExternalDocs,
                                Set<String> classTags,
                                List<Server> classServers,
                                boolean isSubresource,
                                RequestBody parentRequestBody,
                                ApiResponses parentResponses,
                                com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                ApiResponse[] classResponses,
                                com.fasterxml.jackson.databind.introspect.AnnotatedMethod annotatedMethod)

resolveEmptyContent

protected Content resolveEmptyContent(javax.ws.rs.Produces classProduces,
                                      javax.ws.rs.Produces methodProduces)

resolveResponseSchemaFromReturnType

protected void resolveResponseSchemaFromReturnType(Operation operation,
                                                   ApiResponse[] responses,
                                                   Schema schema,
                                                   javax.ws.rs.Produces classProduces,
                                                   javax.ws.rs.Produces methodProduces)

getOperationId

protected String getOperationId(String operationId)

getParametersListFromAnnotation

protected Optional<List<Parameter>> getParametersListFromAnnotation(Parameter[] parameters,
                                                                    javax.ws.rs.Consumes classConsumes,
                                                                    javax.ws.rs.Consumes methodConsumes,
                                                                    Operation operation,
                                                                    com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

getParameters

protected ResolvedParameter getParameters(Type type,
                                          List<Annotation> annotations,
                                          Operation operation,
                                          javax.ws.rs.Consumes classConsumes,
                                          javax.ws.rs.Consumes methodConsumes,
                                          com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

isOperationHidden

protected boolean isOperationHidden(Method method)

isMethodOverridden

protected boolean isMethodOverridden(Method method,
                                     Class<?> cls)

setApplication

public void setApplication(javax.ws.rs.core.Application application)

ignoreOperationPath

protected boolean ignoreOperationPath(String path,
                                      String parentPath)

ignoreOperationPathStrict

protected boolean ignoreOperationPathStrict(String path,
                                            String parentPath)

getSubResourceWithJaxRsSubresourceLocatorSpecs

protected Class<?> getSubResourceWithJaxRsSubresourceLocatorSpecs(Method method)