Package io.smallrye.openapi.jaxrs

Class JaxRsAnnotationScanner

java.lang.Object

io.smallrye.openapi.runtime.scanner.spi.AbstractAnnotationScanner

io.smallrye.openapi.jaxrs.JaxRsAnnotationScanner

All Implemented Interfaces:

AnnotationScanner

public class JaxRsAnnotationScanner
extends AbstractAnnotationScanner

Scanner that scan Jax-Rs entry points. This is also the default, as it's part of the spec.

Author:

Eric Wittmann (eric.wittmann@gmail.com), Phillip Kruger (phillip.kruger@redhat.com)

Field Summary

Fields inherited from class io.smallrye.openapi.runtime.scanner.spi.AbstractAnnotationScanner

context, currentAppPath

Constructor Summary

Constructors

Constructor	Description
JaxRsAnnotationScanner()

Method Summary

Modifier and Type	Method	Description
boolean	containsScannerAnnotations(List<org.jboss.jandex.AnnotationInstance> instances, List<AnnotationScannerExtension> extensions)
String	getName()
boolean	isAsyncResponse(org.jboss.jandex.MethodInfo method)
boolean	isDeleteMethod(org.jboss.jandex.MethodInfo method)
boolean	isFrameworkContextType(org.jboss.jandex.Type type)
boolean	isMultipartInput(org.jboss.jandex.Type inputType)
boolean	isMultipartOutput(org.jboss.jandex.Type returnType)
boolean	isPostMethod(org.jboss.jandex.MethodInfo method)
boolean	isScannerInternalResponse(org.jboss.jandex.Type returnType)
boolean	isWrapperType(org.jboss.jandex.Type type)
org.eclipse.microprofile.openapi.models.OpenAPI	scan(AnnotationScannerContext context, org.eclipse.microprofile.openapi.models.OpenAPI openApi)

Methods inherited from class io.smallrye.openapi.runtime.scanner.spi.AbstractAnnotationScanner

createPathFromSegments, getDefaultConsumes, getDefaultProduces, makePath, processProfiles, setContextRoot

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.smallrye.openapi.runtime.scanner.spi.AnnotationScanner

addApiReponseSchemaFromAnnotation, addResponses, clearJsonViewContext, createResponseFromRestMethod, generateResponse, getConsumes, getConsumesForRequestBody, getDefaultStatus, getKotlinContinuationArgument, getReasonPhrase, getRequestBodyParameterClassType, getResourceMethods, hasKotlinContinuation, isEmptySecurityRequirements, isKotlinContinuation, isPathParameter, isScannerInternalParameter, isScannerInternalResponse, isVoidResponse, isVoidType, kotlinContinuationToSchema, processCallback, processDefinitionAnnotation, processExtensions, processJavaSecurity, processOperation, processOperationTags, processRequestBody, processResponse, processScannerExtensions, processSecurityRequirementAnnotation, processSecuritySchemeAnnotation, processServerAnnotation, processServerAnnotation, processTags, setJsonViewContext, setRequestBodyConstraints, unwrapType

Constructor Details

JaxRsAnnotationScanner

public JaxRsAnnotationScanner()

Method Details

getName

public String getName()

isWrapperType

public boolean isWrapperType(org.jboss.jandex.Type type)

isAsyncResponse

public boolean isAsyncResponse(org.jboss.jandex.MethodInfo method)

isPostMethod

public boolean isPostMethod(org.jboss.jandex.MethodInfo method)

isDeleteMethod

public boolean isDeleteMethod(org.jboss.jandex.MethodInfo method)

isScannerInternalResponse

public boolean isScannerInternalResponse(org.jboss.jandex.Type returnType)

isMultipartOutput

public boolean isMultipartOutput(org.jboss.jandex.Type returnType)

isMultipartInput

public boolean isMultipartInput(org.jboss.jandex.Type inputType)

isFrameworkContextType

public boolean isFrameworkContextType(org.jboss.jandex.Type type)

containsScannerAnnotations

public boolean containsScannerAnnotations(List<org.jboss.jandex.AnnotationInstance> instances,
 List<AnnotationScannerExtension> extensions)

scan

public org.eclipse.microprofile.openapi.models.OpenAPI scan(AnnotationScannerContext context,
 org.eclipse.microprofile.openapi.models.OpenAPI openApi)