public class Reader extends Object implements OpenApiReader
Modifier and Type | Field and Description |
---|---|
protected OpenAPIConfiguration |
config |
static String |
DEFAULT_DESCRIPTION |
static String |
DEFAULT_MEDIA_TYPE_VALUE |
Constructor and Description |
---|
Reader() |
Reader(OpenAPI openAPI) |
Reader(OpenAPIConfiguration openApiConfiguration) |
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 |
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() |
void |
setApplication(javax.ws.rs.core.Application application) |
void |
setConfiguration(OpenAPIConfiguration openApiConfiguration) |
public static final String DEFAULT_MEDIA_TYPE_VALUE
public static final String DEFAULT_DESCRIPTION
protected OpenAPIConfiguration config
public Reader()
public Reader(OpenAPI openAPI)
public Reader(OpenAPIConfiguration openApiConfiguration)
public OpenAPI getOpenAPI()
public OpenAPI read(Class<?> cls)
public OpenAPI read(Set<Class<?>> classes)
classes
- a set of classes to scanpublic void setConfiguration(OpenAPIConfiguration openApiConfiguration)
setConfiguration
in interface OpenApiReader
public OpenAPI read(Set<Class<?>> classes, Map<String,Object> resources)
read
in interface OpenApiReader
protected String resolveApplicationPath()
public OpenAPI read(Class<?> cls, String parentPath, String parentMethod, boolean isSubresource, RequestBody parentRequestBody, ApiResponses parentResponses, Set<String> parentTags, List<Parameter> parentParameters, Set<Class<?>> scannedResources)
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)
public Operation parseMethod(Method method, List<Parameter> globalParameters, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
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)
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)
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)
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 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 boolean isOperationHidden(Method method)
public void setApplication(javax.ws.rs.core.Application application)
Copyright © 2021. All rights reserved.