A C D G I R S W
All Classes All Packages

A

ApiDeclarationServlet - Class in io.swagger.servlet.listing

The ApiDeclarationServlet class implements servlet which returns the Swagger definition.

ApiDeclarationServlet() - Constructor for class io.swagger.servlet.listing.ApiDeclarationServlet

applyConsumes(ReaderContext, Operation, Method) - Method in interface io.swagger.servlet.extensions.ReaderExtension

Reads the consumes from the method's annotations and applies these to the operation.

applyConsumes(ReaderContext, Operation, Method) - Method in class io.swagger.servlet.extensions.ServletReaderExtension

applyDescription(Operation, Method) - Method in interface io.swagger.servlet.extensions.ReaderExtension

Reads the description from the method's annotations and applies it to the operation.

applyDescription(Operation, Method) - Method in class io.swagger.servlet.extensions.ServletReaderExtension

applyExtensions(ReaderContext, Operation, Method) - Method in interface io.swagger.servlet.extensions.ReaderExtension

Reads the extensions from the method's annotations and applies these to the operation.

applyExtensions(ReaderContext, Operation, Method) - Method in class io.swagger.servlet.extensions.ServletReaderExtension

applyImplicitParameters(ReaderContext, Operation, Method) - Method in interface io.swagger.servlet.extensions.ReaderExtension

Reads the implicit parameters from the method's annotations and applies these to the operation.

applyImplicitParameters(ReaderContext, Operation, Method) - Method in class io.swagger.servlet.extensions.ServletReaderExtension

applyOperationId(Operation, Method) - Method in interface io.swagger.servlet.extensions.ReaderExtension

Reads the operation id from the method's annotations and applies it to the operation.

applyOperationId(Operation, Method) - Method in class io.swagger.servlet.extensions.ServletReaderExtension

applyParameters(ReaderContext, Operation, Type, Annotation[]) - Method in interface io.swagger.servlet.extensions.ReaderExtension

Reads the parameters from the method's annotations and applies these to the operation.

applyParameters(ReaderContext, Operation, Type, Annotation[]) - Method in class io.swagger.servlet.extensions.ServletReaderExtension

applyProduces(ReaderContext, Operation, Method) - Method in interface io.swagger.servlet.extensions.ReaderExtension

Reads the produces from the method's annotations and applies these to the operation.

applyProduces(ReaderContext, Operation, Method) - Method in class io.swagger.servlet.extensions.ServletReaderExtension

applyResponses(ReaderContext, Operation, Method) - Method in interface io.swagger.servlet.extensions.ReaderExtension

Reads the responses from the method's annotations and applies these to the operation.

applyResponses(ReaderContext, Operation, Method) - Method in class io.swagger.servlet.extensions.ServletReaderExtension

applySchemes(ReaderContext, Operation, Method) - Method in interface io.swagger.servlet.extensions.ReaderExtension

Reads the schemes from the method's annotations and applies these to the operation.

applySchemes(ReaderContext, Operation, Method) - Method in class io.swagger.servlet.extensions.ServletReaderExtension

applySecurityRequirements(ReaderContext, Operation, Method) - Method in interface io.swagger.servlet.extensions.ReaderExtension

Reads the security requirement from the method's annotations and applies these to the operation.

applySecurityRequirements(ReaderContext, Operation, Method) - Method in class io.swagger.servlet.extensions.ServletReaderExtension

applySummary(Operation, Method) - Method in interface io.swagger.servlet.extensions.ReaderExtension

Reads the summary from the method's annotations and applies it to the operation.

applySummary(Operation, Method) - Method in class io.swagger.servlet.extensions.ServletReaderExtension

applyTags(ReaderContext, Operation, Method) - Method in interface io.swagger.servlet.extensions.ReaderExtension

Reads the tags from the method's annotations and applies these to the operation.

applyTags(ReaderContext, Operation, Method) - Method in class io.swagger.servlet.extensions.ServletReaderExtension

C

classes() - Method in class io.swagger.servlet.config.ServletScanner

configure(Swagger) - Method in class io.swagger.servlet.config.WebXMLReader

D

DefaultServletConfig - Class in io.swagger.servlet.config

DefaultServletConfig() - Constructor for class io.swagger.servlet.config.DefaultServletConfig

doGet(HttpServletRequest, HttpServletResponse) - Method in class io.swagger.servlet.listing.ApiDeclarationServlet

G

getCls() - Method in class io.swagger.servlet.ReaderContext

getExtensions() - Static method in class io.swagger.servlet.extensions.ReaderExtensions

getFilterClass() - Method in class io.swagger.servlet.config.WebXMLReader

getHttpMethod(ReaderContext, Method) - Method in interface io.swagger.servlet.extensions.ReaderExtension

Returns http method.

getHttpMethod(ReaderContext, Method) - Method in class io.swagger.servlet.extensions.ServletReaderExtension

getParentConsumes() - Method in class io.swagger.servlet.ReaderContext

getParentHttpMethod() - Method in class io.swagger.servlet.ReaderContext

getParentParameters() - Method in class io.swagger.servlet.ReaderContext

getParentPath() - Method in class io.swagger.servlet.ReaderContext

getParentProduces() - Method in class io.swagger.servlet.ReaderContext

getParentTags() - Method in class io.swagger.servlet.ReaderContext

getPath(ReaderContext, Method) - Method in interface io.swagger.servlet.extensions.ReaderExtension

Returns operation's path.

getPath(ReaderContext, Method) - Method in class io.swagger.servlet.extensions.ServletReaderExtension

getPrettyPrint() - Method in class io.swagger.servlet.config.ServletScanner

getPriority() - Method in interface io.swagger.servlet.extensions.ReaderExtension

Returns this extension's priority.

getPriority() - Method in class io.swagger.servlet.extensions.ServletReaderExtension

getResourcePackage() - Method in class io.swagger.servlet.config.ServletScanner

getSwagger() - Method in class io.swagger.servlet.ReaderContext

I

init(ServletConfig) - Method in class io.swagger.servlet.config.DefaultServletConfig

init(ServletConfig) - Method in class io.swagger.servlet.listing.ApiDeclarationServlet

io.swagger.servlet - package io.swagger.servlet

io.swagger.servlet.config - package io.swagger.servlet.config

io.swagger.servlet.extensions - package io.swagger.servlet.extensions

io.swagger.servlet.listing - package io.swagger.servlet.listing

isReadable(ReaderContext) - Method in interface io.swagger.servlet.extensions.ReaderExtension

Checks that a resource should be scanned.

isReadable(ReaderContext) - Method in class io.swagger.servlet.extensions.ServletReaderExtension

isReadHidden() - Method in class io.swagger.servlet.ReaderContext

R

read(Swagger, Set<Class<?>>) - Static method in class io.swagger.servlet.Reader

Scans a set of classes for Swagger annotations.

Reader - Class in io.swagger.servlet

The Reader class scans classes for Swagger annotations.

ReaderContext - Class in io.swagger.servlet

The ReaderContext class is wrapper for the Reader parameters.

ReaderContext(Swagger, Class<?>, String, String, boolean, List<String>, List<String>, List<String>, List<Parameter>) - Constructor for class io.swagger.servlet.ReaderContext

ReaderExtension - Interface in io.swagger.servlet.extensions

The ReaderExtension interface defines methods for scans resources for Swagger.

ReaderExtensions - Class in io.swagger.servlet.extensions

ReaderExtensions() - Constructor for class io.swagger.servlet.extensions.ReaderExtensions

S

ServletReaderExtension - Class in io.swagger.servlet.extensions

ServletReaderExtension() - Constructor for class io.swagger.servlet.extensions.ServletReaderExtension

ServletScanner - Class in io.swagger.servlet.config

ServletScanner(ServletConfig) - Constructor for class io.swagger.servlet.config.ServletScanner

setCls(Class<?>) - Method in class io.swagger.servlet.ReaderContext

setDeprecated(Operation, Method) - Method in interface io.swagger.servlet.extensions.ReaderExtension

Sets the deprecated flag to the operation.

setDeprecated(Operation, Method) - Method in class io.swagger.servlet.extensions.ServletReaderExtension

setParentConsumes(List<String>) - Method in class io.swagger.servlet.ReaderContext

setParentHttpMethod(String) - Method in class io.swagger.servlet.ReaderContext

setParentParameters(List<Parameter>) - Method in class io.swagger.servlet.ReaderContext

setParentPath(String) - Method in class io.swagger.servlet.ReaderContext

setParentProduces(List<String>) - Method in class io.swagger.servlet.ReaderContext

setParentTags(List<String>) - Method in class io.swagger.servlet.ReaderContext

setPrettyPrint(boolean) - Method in class io.swagger.servlet.config.ServletScanner

setReadHidden(boolean) - Method in class io.swagger.servlet.ReaderContext

setResourcePackage(String) - Method in class io.swagger.servlet.config.ServletScanner

setSwagger(Swagger) - Method in class io.swagger.servlet.ReaderContext

W

WebXMLReader - Class in io.swagger.servlet.config

WebXMLReader(ServletConfig) - Constructor for class io.swagger.servlet.config.WebXMLReader

A C D G I R S W
All Classes All Packages