public interface ReaderExtension
ReaderExtension
interface defines methods for scans resources for Swagger.Modifier and Type | Method and Description |
---|---|
void |
applyConsumes(ReaderContext context,
Operation operation,
Method method)
Reads the consumes from the method's annotations and applies these to the operation.
|
void |
applyDescription(Operation operation,
Method method)
Reads the description from the method's annotations and applies it to the operation.
|
void |
applyExtensions(ReaderContext context,
Operation operation,
Method method)
Reads the extensions from the method's annotations and applies these to the operation.
|
void |
applyImplicitParameters(ReaderContext context,
Operation operation,
Method method)
Reads the implicit parameters from the method's annotations and applies these to the operation.
|
void |
applyOperationId(Operation operation,
Method method)
Reads the operation id from the method's annotations and applies it to the operation.
|
void |
applyParameters(ReaderContext context,
Operation operation,
Type type,
Annotation[] annotations)
Reads the parameters from the method's annotations and applies these to the operation.
|
void |
applyProduces(ReaderContext context,
Operation operation,
Method method)
Reads the produces from the method's annotations and applies these to the operation.
|
void |
applyResponses(ReaderContext context,
Operation operation,
Method method)
Reads the responses from the method's annotations and applies these to the operation.
|
void |
applySchemes(ReaderContext context,
Operation operation,
Method method)
Reads the schemes from the method's annotations and applies these to the operation.
|
void |
applySecurityRequirements(ReaderContext context,
Operation operation,
Method method)
Reads the security requirement from the method's annotations and applies these to the operation.
|
void |
applySummary(Operation operation,
Method method)
Reads the summary from the method's annotations and applies it to the operation.
|
void |
applyTags(ReaderContext context,
Operation operation,
Method method)
Reads the tags from the method's annotations and applies these to the operation.
|
String |
getHttpMethod(ReaderContext context,
Method method)
Returns http method.
|
String |
getPath(ReaderContext context,
Method method)
Returns operation's path.
|
int |
getPriority()
Returns this extension's priority.
|
boolean |
isReadable(ReaderContext context)
Checks that a resource should be scanned.
|
void |
setDeprecated(Operation operation,
Method method)
Sets the deprecated flag to the operation.
|
int getPriority()
boolean isReadable(ReaderContext context)
context
- is the resource contextvoid applyConsumes(ReaderContext context, Operation operation, Method method)
context
- is the resource contextoperation
- is the container for the operation datamethod
- is the method for reading annotationsvoid applyProduces(ReaderContext context, Operation operation, Method method)
context
- is the resource contextoperation
- is the container for the operation datamethod
- is the method for reading annotationsString getHttpMethod(ReaderContext context, Method method)
context
- is the resource contextmethod
- is the method for reading annotationsString getPath(ReaderContext context, Method method)
context
- is the resource contextmethod
- is the method for reading annotationsvoid applyOperationId(Operation operation, Method method)
operation
- is the container for the operation datamethod
- is the method for reading annotationsvoid applySummary(Operation operation, Method method)
operation
- is the container for the operation datamethod
- is the method for reading annotationsvoid applyDescription(Operation operation, Method method)
operation
- is the container for the operation datamethod
- is the method for reading annotationsvoid applySchemes(ReaderContext context, Operation operation, Method method)
context
- is the resource contextoperation
- is the container for the operation datamethod
- is the method for reading annotationsvoid setDeprecated(Operation operation, Method method)
operation
- is the container for the operation datamethod
- is the method for reading annotationsvoid applySecurityRequirements(ReaderContext context, Operation operation, Method method)
context
- is the resource contextoperation
- is the container for the operation datamethod
- is the method for reading annotationsvoid applyTags(ReaderContext context, Operation operation, Method method)
context
- is the resource contextoperation
- is the container for the operation datamethod
- is the method for reading annotationsvoid applyResponses(ReaderContext context, Operation operation, Method method)
context
- is the resource contextoperation
- is the container for the operation datamethod
- is the method for reading annotationsvoid applyParameters(ReaderContext context, Operation operation, Type type, Annotation[] annotations)
context
- is the resource contextoperation
- is the container for the operation datatype
- is the type of parameterannotations
- are the method's annotationsvoid applyImplicitParameters(ReaderContext context, Operation operation, Method method)
context
- is the resource contextoperation
- is the container for the operation datamethod
- is the method for reading annotationsvoid applyExtensions(ReaderContext context, Operation operation, Method method)
context
- is the resource contextoperation
- is the container for the operation datamethod
- is the method for reading annotationsCopyright © 2018. All rights reserved.