A B C D E F G H I J P R S T U W

A

AbstractScanner - Class in io.swagger.jaxrs.config

AbstractScanner() - Constructor for class io.swagger.jaxrs.config.AbstractScanner

AbstractSwaggerExtension - Class in io.swagger.jaxrs.ext

AbstractSwaggerExtension() - Constructor for class io.swagger.jaxrs.ext.AbstractSwaggerExtension

acceptablePackages - Variable in class io.swagger.jaxrs.config.ReflectiveJaxrsScanner

AcceptHeaderApiListingResource - Class in io.swagger.jaxrs.listing

Created by rbolles on 2/15/16.

AcceptHeaderApiListingResource() - Constructor for class io.swagger.jaxrs.listing.AcceptHeaderApiListingResource

afterScan(Reader, Swagger) - Method in interface io.swagger.jaxrs.config.ReaderListener

Called after a Swagger definition has been populated from scanned classes.

ApiListingResource - Class in io.swagger.jaxrs.listing

ApiListingResource() - Constructor for class io.swagger.jaxrs.listing.ApiListingResource

apiVersion - Variable in class io.swagger.jaxrs.config.WebXMLReader

B

BaseApiListingResource - Class in io.swagger.jaxrs.listing

Created by rbolles on 2/15/16.

BaseApiListingResource() - Constructor for class io.swagger.jaxrs.listing.BaseApiListingResource

basePath - Variable in class io.swagger.jaxrs.config.WebXMLReader

BeanConfig - Class in io.swagger.jaxrs.config

BeanConfig() - Constructor for class io.swagger.jaxrs.config.BeanConfig

beforeScan(Reader, Swagger) - Method in interface io.swagger.jaxrs.config.ReaderListener

Called before the Swagger definition gets populated from scanned classes.

C

chain() - Static method in class io.swagger.jaxrs.ext.SwaggerExtensions

classes() - Method in class io.swagger.jaxrs.config.BeanConfig

classes() - Method in class io.swagger.jaxrs.config.DefaultJaxrsScanner

classes() - Method in class io.swagger.jaxrs.config.ReflectiveJaxrsScanner

classesFromContext(Application, ServletConfig) - Method in class io.swagger.jaxrs.config.DefaultJaxrsScanner

classesFromContext(Application, ServletConfig) - Method in interface io.swagger.jaxrs.config.JaxrsScanner

collectConstructorParameters(Class<?>, Swagger) - Static method in class io.swagger.jaxrs.utils.ReaderUtils

Collects constructor-level parameters from class.

collectFieldParameters(Class<?>, Swagger) - Static method in class io.swagger.jaxrs.utils.ReaderUtils

Collects field-level parameters from class.

CONFIG_ID_DEFAULT - Static variable in class io.swagger.jaxrs.config.SwaggerContextService

CONFIG_ID_KEY - Static variable in class io.swagger.jaxrs.config.SwaggerContextService

CONFIG_ID_PREFIX - Static variable in class io.swagger.jaxrs.config.SwaggerContextService

configure(Swagger) - Method in class io.swagger.jaxrs.config.BeanConfig

configure(Swagger) - Method in class io.swagger.jaxrs.config.ReflectiveJaxrsScanner

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

constructType(Type) - Method in class io.swagger.jaxrs.ext.AbstractSwaggerExtension

CONTEXT_ID_KEY - Static variable in class io.swagger.jaxrs.config.SwaggerContextService

D

decorateOperation(Operation, Method, Iterator<SwaggerExtension>) - Method in class io.swagger.jaxrs.ext.AbstractSwaggerExtension

decorateOperation(Operation, Method, Iterator<SwaggerExtension>) - Method in interface io.swagger.jaxrs.ext.SwaggerExtension

Decorates operation with additional vendor based extensions.

DefaultJaxrsConfig - Class in io.swagger.jaxrs.config

DefaultJaxrsConfig() - Constructor for class io.swagger.jaxrs.config.DefaultJaxrsConfig

DefaultJaxrsScanner - Class in io.swagger.jaxrs.config

DefaultJaxrsScanner() - Constructor for class io.swagger.jaxrs.config.DefaultJaxrsScanner

DefaultParameterExtension - Class in io.swagger.jaxrs

DefaultParameterExtension() - Constructor for class io.swagger.jaxrs.DefaultParameterExtension

DefaultReaderConfig - Class in io.swagger.jaxrs.config

The ReaderConfig interface defines configuration settings for JAX-RS annotations reader.

DefaultReaderConfig() - Constructor for class io.swagger.jaxrs.config.DefaultReaderConfig

Creates default configuration.

DefaultReaderConfig(ReaderConfig) - Constructor for class io.swagger.jaxrs.config.DefaultReaderConfig

Creates a copy of passed configuration.

E

extractOperationMethod(ApiOperation, Method, Iterator<SwaggerExtension>) - Method in class io.swagger.jaxrs.ext.AbstractSwaggerExtension

extractOperationMethod(ApiOperation, Method, Iterator<SwaggerExtension>) - Method in interface io.swagger.jaxrs.ext.SwaggerExtension

extractOperationMethod(ApiOperation, Method, Iterator<SwaggerExtension>) - Method in class io.swagger.jaxrs.Reader

extractParameters(List<Annotation>, Type, Set<Type>, Iterator<SwaggerExtension>) - Method in class io.swagger.jaxrs.DefaultParameterExtension

extractParameters(List<Annotation>, Type, Set<Type>, Iterator<SwaggerExtension>) - Method in class io.swagger.jaxrs.ext.AbstractSwaggerExtension

extractParameters(List<Annotation>, Type, Set<Type>, Iterator<SwaggerExtension>) - Method in interface io.swagger.jaxrs.ext.SwaggerExtension

extractTags(Api) - Method in class io.swagger.jaxrs.Reader

F

filterClass - Variable in class io.swagger.jaxrs.config.ReflectiveJaxrsScanner

filterClass - Variable in class io.swagger.jaxrs.config.WebXMLReader

G

getBasePath() - Method in class io.swagger.jaxrs.config.BeanConfig

getBasePath() - Method in class io.swagger.jaxrs.config.SwaggerContextService

getConfig(String) - Method in class io.swagger.jaxrs.config.SwaggerConfigLocator

getConfig() - Method in class io.swagger.jaxrs.config.SwaggerContextService

getConfig() - Method in class io.swagger.jaxrs.Reader

getConfigId() - Method in class io.swagger.jaxrs.config.BeanConfig

getConfigIdFromInitParam(ServletConfig) - Static method in class io.swagger.jaxrs.config.SwaggerContextService

getContact() - Method in class io.swagger.jaxrs.config.BeanConfig

getContextId() - Method in class io.swagger.jaxrs.config.BeanConfig

getDescription() - Method in class io.swagger.jaxrs.config.BeanConfig

getExtensions() - Static method in class io.swagger.jaxrs.ext.SwaggerExtensions

getFilterClass() - Method in class io.swagger.jaxrs.config.BeanConfig

getFilterClass() - Method in class io.swagger.jaxrs.config.ReflectiveJaxrsScanner

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

getHost() - Method in class io.swagger.jaxrs.config.BeanConfig

getIgnoredRoutes() - Method in class io.swagger.jaxrs.config.DefaultReaderConfig

getIgnoredRoutes() - Method in interface io.swagger.jaxrs.config.ReaderConfig

Returns paths of resources to be ignored.

getInfo() - Method in class io.swagger.jaxrs.config.BeanConfig

getInstance() - Static method in class io.swagger.jaxrs.config.SwaggerConfigLocator

getInstance() - Static method in class io.swagger.jaxrs.config.SwaggerScannerLocator

getLicense() - Method in class io.swagger.jaxrs.config.BeanConfig

getLicenseUrl() - Method in class io.swagger.jaxrs.config.BeanConfig

getListing(Application, ServletConfig, HttpHeaders, UriInfo, String) - Method in class io.swagger.jaxrs.listing.ApiListingResource

getListingJson(Application, ServletConfig, HttpHeaders, UriInfo) - Method in class io.swagger.jaxrs.listing.AcceptHeaderApiListingResource

getListingJsonResponse(Application, ServletContext, ServletConfig, HttpHeaders, UriInfo) - Method in class io.swagger.jaxrs.listing.BaseApiListingResource

getListingYaml(Application, ServletConfig, HttpHeaders, UriInfo) - Method in class io.swagger.jaxrs.listing.AcceptHeaderApiListingResource

getListingYamlResponse(Application, ServletContext, ServletConfig, HttpHeaders, UriInfo) - Method in class io.swagger.jaxrs.listing.BaseApiListingResource

getOperationId(String) - Method in class io.swagger.jaxrs.Reader

getPrettyPrint() - Method in class io.swagger.jaxrs.config.AbstractScanner

getPrettyPrint() - Method in class io.swagger.jaxrs.config.ReflectiveJaxrsScanner

getReaderConfig(ServletContext) - Static method in class io.swagger.jaxrs.config.ReaderConfigUtils

getReflections() - Method in class io.swagger.jaxrs.config.ReflectiveJaxrsScanner

getResourcePackage() - Method in class io.swagger.jaxrs.config.BeanConfig

getResourcePackage() - Method in class io.swagger.jaxrs.config.ReflectiveJaxrsScanner

getScan() - Method in class io.swagger.jaxrs.config.BeanConfig

getScanner() - Method in class io.swagger.jaxrs.config.SwaggerContextService

getScanner(String) - Method in class io.swagger.jaxrs.config.SwaggerScannerLocator

getScannerId() - Method in class io.swagger.jaxrs.config.BeanConfig

getScannerIdFromInitParam(ServletConfig) - Static method in class io.swagger.jaxrs.config.SwaggerContextService

getSchemes() - Method in class io.swagger.jaxrs.config.BeanConfig

getSize(Swagger, Class, Type, Annotation[], MediaType) - Method in class io.swagger.jaxrs.listing.SwaggerSerializers

getSubResource(Method) - Method in class io.swagger.jaxrs.Reader

getSubResourceWithJaxRsSubresourceLocatorSpecs(Method) - Method in class io.swagger.jaxrs.Reader

getSwagger() - Method in class io.swagger.jaxrs.config.BeanConfig

getSwagger(String) - Method in class io.swagger.jaxrs.config.SwaggerConfigLocator

getSwagger() - Method in class io.swagger.jaxrs.config.SwaggerContextService

getSwagger() - Method in class io.swagger.jaxrs.Reader

getTermsOfServiceUrl() - Method in class io.swagger.jaxrs.config.BeanConfig

getTitle() - Method in class io.swagger.jaxrs.config.BeanConfig

getVersion() - Method in class io.swagger.jaxrs.config.BeanConfig

H

host - Variable in class io.swagger.jaxrs.config.WebXMLReader

I

init(ServletConfig) - Method in class io.swagger.jaxrs.config.DefaultJaxrsConfig

initConfig() - Method in class io.swagger.jaxrs.config.SwaggerContextService

initConfig(Swagger) - Method in class io.swagger.jaxrs.config.SwaggerContextService

initReaderConfig(ServletConfig) - Static method in class io.swagger.jaxrs.config.ReaderConfigUtils

initScanner() - Method in class io.swagger.jaxrs.config.SwaggerContextService

io.swagger.jaxrs - package io.swagger.jaxrs

io.swagger.jaxrs.config - package io.swagger.jaxrs.config

io.swagger.jaxrs.ext - package io.swagger.jaxrs.ext

io.swagger.jaxrs.listing - package io.swagger.jaxrs.listing

io.swagger.jaxrs.utils - package io.swagger.jaxrs.utils

isConfigIdInitParamDefined(ServletConfig) - Static method in class io.swagger.jaxrs.config.SwaggerContextService

isScanAllResources() - Method in class io.swagger.jaxrs.config.DefaultReaderConfig

isScanAllResources() - Method in interface io.swagger.jaxrs.config.ReaderConfig

Checks if all resources, but not those with the Api annotation has to be processed.

isScannerIdInitParamDefined(ServletConfig) - Static method in class io.swagger.jaxrs.config.SwaggerContextService

isServletConfigAvailable(ServletConfig) - Static method in class io.swagger.jaxrs.config.SwaggerContextService

isUsePathBasedConfig() - Method in class io.swagger.jaxrs.config.BeanConfig

isUsePathBasedConfig() - Method in class io.swagger.jaxrs.config.SwaggerContextService

isUsePathBasedConfigInitParamDefined(ServletConfig) - Static method in class io.swagger.jaxrs.config.SwaggerContextService

isWriteable(Class, Type, Annotation[], MediaType) - Method in class io.swagger.jaxrs.listing.SwaggerSerializers

J

JaxrsScanner - Interface in io.swagger.jaxrs.config

P

parseMethod(Method) - Method in class io.swagger.jaxrs.Reader

PATCH - Annotation Type in io.swagger.jaxrs

prettyPrint - Variable in class io.swagger.jaxrs.config.AbstractScanner

prettyPrint() - Method in class io.swagger.jaxrs.config.DefaultJaxrsScanner

prettyPrint - Variable in class io.swagger.jaxrs.config.ReflectiveJaxrsScanner

process(Application, ServletContext, ServletConfig, HttpHeaders, UriInfo) - Method in class io.swagger.jaxrs.listing.BaseApiListingResource

putConfig(String, SwaggerConfig) - Method in class io.swagger.jaxrs.config.SwaggerConfigLocator

putScanner(String, Scanner) - Method in class io.swagger.jaxrs.config.SwaggerScannerLocator

putSwagger(String, Swagger) - Method in class io.swagger.jaxrs.config.SwaggerConfigLocator

R

read(Set<Class<?>>) - Method in class io.swagger.jaxrs.Reader

Scans a set of classes for both ReaderListeners and Swagger annotations.

read(Class<?>) - Method in class io.swagger.jaxrs.Reader

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

read(Class<?>, String, String, boolean, String[], String[], Map<String, Tag>, List<Parameter>) - Method in class io.swagger.jaxrs.Reader

Reader - Class in io.swagger.jaxrs

Reader(Swagger) - Constructor for class io.swagger.jaxrs.Reader

Reader(Swagger, ReaderConfig) - Constructor for class io.swagger.jaxrs.Reader

ReaderConfig - Interface in io.swagger.jaxrs.config

The ReaderConfig interface defines configuration settings for JAX-RS annotations reader.

ReaderConfigUtils - Class in io.swagger.jaxrs.config

The ReaderConfigUtils class defines helper methods for handling configuration settings for JAX-RS annotations reader.

ReaderListener - Interface in io.swagger.jaxrs.config

Listener providing hooks for customizing automatically generated Swagger definitions in a JAX-RS environment.

ReaderUtils - Class in io.swagger.jaxrs.utils

ReaderUtils() - Constructor for class io.swagger.jaxrs.utils.ReaderUtils

readImplicitParam(ApiImplicitParam) - Method in class io.swagger.jaxrs.Reader

readInfoConfig(SwaggerDefinition) - Method in class io.swagger.jaxrs.Reader

readSwaggerConfig(Class<?>, SwaggerDefinition) - Method in class io.swagger.jaxrs.Reader

reflections - Variable in class io.swagger.jaxrs.config.ReflectiveJaxrsScanner

ReflectiveJaxrsScanner - Class in io.swagger.jaxrs.config

ReflectiveJaxrsScanner() - Constructor for class io.swagger.jaxrs.config.ReflectiveJaxrsScanner

resourcePackage - Variable in class io.swagger.jaxrs.config.ReflectiveJaxrsScanner

S

scanAndRead() - Method in class io.swagger.jaxrs.config.BeanConfig

SCANNER_ID_DEFAULT - Static variable in class io.swagger.jaxrs.config.SwaggerContextService

SCANNER_ID_KEY - Static variable in class io.swagger.jaxrs.config.SwaggerContextService

SCANNER_ID_PREFIX - Static variable in class io.swagger.jaxrs.config.SwaggerContextService

schemes - Variable in class io.swagger.jaxrs.config.WebXMLReader

setBasePath(String) - Method in class io.swagger.jaxrs.config.BeanConfig

setBasePath(String) - Method in class io.swagger.jaxrs.config.SwaggerContextService

setConfigId(String) - Method in class io.swagger.jaxrs.config.BeanConfig

setConfigId(String) - Method in class io.swagger.jaxrs.config.SwaggerContextService

setContact(String) - Method in class io.swagger.jaxrs.config.BeanConfig

setContextId(String) - Method in class io.swagger.jaxrs.config.BeanConfig

setContextId(String) - Method in class io.swagger.jaxrs.config.SwaggerContextService

setDescription(String) - Method in class io.swagger.jaxrs.config.BeanConfig

setExtensions(List<SwaggerExtension>) - Static method in class io.swagger.jaxrs.ext.SwaggerExtensions

setFilterClass(String) - Method in class io.swagger.jaxrs.config.BeanConfig

setFilterClass(String) - Method in class io.swagger.jaxrs.config.ReflectiveJaxrsScanner

setHost(String) - Method in class io.swagger.jaxrs.config.BeanConfig

setIgnoredRoutes(Collection<String>) - Method in class io.swagger.jaxrs.config.DefaultReaderConfig

setInfo(Info) - Method in class io.swagger.jaxrs.config.BeanConfig

setLicense(String) - Method in class io.swagger.jaxrs.config.BeanConfig

setLicenseUrl(String) - Method in class io.swagger.jaxrs.config.BeanConfig

setPrettyPrint(boolean) - Method in class io.swagger.jaxrs.config.AbstractScanner

setPrettyPrint(String) - Method in class io.swagger.jaxrs.config.BeanConfig

setPrettyPrint(boolean) - Method in class io.swagger.jaxrs.config.ReflectiveJaxrsScanner

setPrettyPrint(boolean) - Static method in class io.swagger.jaxrs.listing.SwaggerSerializers

setReflections(Reflections) - Method in class io.swagger.jaxrs.config.ReflectiveJaxrsScanner

setResourcePackage(String) - Method in class io.swagger.jaxrs.config.BeanConfig

setResourcePackage(String) - Method in class io.swagger.jaxrs.config.ReflectiveJaxrsScanner

setSc(ServletConfig) - Method in class io.swagger.jaxrs.config.SwaggerContextService

setScan(boolean) - Method in class io.swagger.jaxrs.config.BeanConfig

setScan() - Method in class io.swagger.jaxrs.config.BeanConfig

setScanAllResources(boolean) - Method in class io.swagger.jaxrs.config.DefaultReaderConfig

setScanner(Scanner) - Method in class io.swagger.jaxrs.config.SwaggerContextService

setScannerId(String) - Method in class io.swagger.jaxrs.config.BeanConfig

setScannerId(String) - Method in class io.swagger.jaxrs.config.SwaggerContextService

setSchemes(String[]) - Method in class io.swagger.jaxrs.config.BeanConfig

setServletConfig(ServletConfig) - Method in class io.swagger.jaxrs.config.BeanConfig

setSwaggerConfig(SwaggerConfig) - Method in class io.swagger.jaxrs.config.SwaggerContextService

setTermsOfServiceUrl(String) - Method in class io.swagger.jaxrs.config.BeanConfig

setTitle(String) - Method in class io.swagger.jaxrs.config.BeanConfig

setUsePathBasedConfig(boolean) - Method in class io.swagger.jaxrs.config.BeanConfig

setUsePathBasedConfig(boolean) - Method in class io.swagger.jaxrs.config.SwaggerContextService

setVersion(String) - Method in class io.swagger.jaxrs.config.BeanConfig

shouldIgnoreClass(Class<?>) - Method in class io.swagger.jaxrs.DefaultParameterExtension

shouldIgnoreClass(Class<?>) - Method in class io.swagger.jaxrs.ext.AbstractSwaggerExtension

shouldIgnoreType(Type, Set<Type>) - Method in class io.swagger.jaxrs.ext.AbstractSwaggerExtension

splitContentValues(String[]) - Static method in class io.swagger.jaxrs.utils.ReaderUtils

Splits the provided array of strings into an array, using comma as the separator.

SwaggerConfigLocator - Class in io.swagger.jaxrs.config

SwaggerContextService - Class in io.swagger.jaxrs.config

SwaggerContextService() - Constructor for class io.swagger.jaxrs.config.SwaggerContextService

SwaggerExtension - Interface in io.swagger.jaxrs.ext

SwaggerExtensions - Class in io.swagger.jaxrs.ext

SwaggerExtensions() - Constructor for class io.swagger.jaxrs.ext.SwaggerExtensions

SwaggerScannerLocator - Class in io.swagger.jaxrs.config

SwaggerSerializers - Class in io.swagger.jaxrs.listing

SwaggerSerializers() - Constructor for class io.swagger.jaxrs.listing.SwaggerSerializers

T

title - Variable in class io.swagger.jaxrs.config.WebXMLReader

U

updateSwagger(Swagger) - Method in class io.swagger.jaxrs.config.SwaggerContextService

USE_PATH_BASED_CONFIG - Static variable in class io.swagger.jaxrs.config.SwaggerContextService

W

WebXMLReader - Class in io.swagger.jaxrs.config

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

withBasePath(String) - Method in class io.swagger.jaxrs.config.SwaggerContextService

withConfigId(String) - Method in class io.swagger.jaxrs.config.SwaggerContextService

withContextId(String) - Method in class io.swagger.jaxrs.config.SwaggerContextService

withPathBasedConfig(boolean) - Method in class io.swagger.jaxrs.config.SwaggerContextService

withScanner(Scanner) - Method in class io.swagger.jaxrs.config.SwaggerContextService

withScannerId(String) - Method in class io.swagger.jaxrs.config.SwaggerContextService

withServletConfig(ServletConfig) - Method in class io.swagger.jaxrs.config.SwaggerContextService

withSwaggerConfig(SwaggerConfig) - Method in class io.swagger.jaxrs.config.SwaggerContextService

writeTo(Swagger, Class<?>, Type, Annotation[], MediaType, MultivaluedMap<String, Object>, OutputStream) - Method in class io.swagger.jaxrs.listing.SwaggerSerializers

A B C D E F G H I J P R S T U W