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

A

AbsoluteSwaggerPathProvider - Class in com.mangofactory.swagger.paths
 
AbsoluteSwaggerPathProvider() - Constructor for class com.mangofactory.swagger.paths.AbsoluteSwaggerPathProvider
 
addApiListings(String, Map<String, ApiListing>) - Method in class com.mangofactory.swagger.core.SwaggerCache
 
addSwaggerResourceListing(String, ResourceListing) - Method in class com.mangofactory.swagger.core.SwaggerCache
 
alternateTypeProvider(AlternateTypeProvider) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Overrides the default AlternateTypeProvider.
alternateTypeRules(AlternateTypeRule...) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Adds model substitution rules (alternateTypeRules)
AntRequestMappingPatternMatcher - Class in com.mangofactory.swagger.scanners
 
AntRequestMappingPatternMatcher() - Constructor for class com.mangofactory.swagger.scanners.AntRequestMappingPatternMatcher
 
ApiDescriptionLexicographicalOrdering - Class in com.mangofactory.swagger.ordering
 
ApiDescriptionLexicographicalOrdering() - Constructor for class com.mangofactory.swagger.ordering.ApiDescriptionLexicographicalOrdering
 
apiDescriptionOrdering(Ordering<ApiDescription>) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Controls how com.wordnik.swagger.model.ApiDescription's are ordered.
ApiDescriptionReader - Class in com.mangofactory.swagger.readers
 
ApiDescriptionReader(SwaggerPathProvider, Collection<RequestMappingReader>, RequestMappingEvaluator) - Constructor for class com.mangofactory.swagger.readers.ApiDescriptionReader
 
ApiIgnore - Annotation Type in com.mangofactory.swagger.annotations
 
apiInfo(ApiInfo) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Sets the api's meta information as included in the json ResourceListing response.
apiListingReferenceOrdering(Ordering<ApiListingReference>) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Controls how ApiListingReference's are sorted.
ApiListingReferenceScanner - Class in com.mangofactory.swagger.scanners
 
ApiListingReferenceScanner() - Constructor for class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
 
ApiListingScanner - Class in com.mangofactory.swagger.scanners
 
ApiListingScanner(Map<ResourceGroup, List<RequestMappingContext>>, SwaggerPathProvider, ModelProvider, AuthorizationContext, Collection<RequestMappingReader>, RequestMappingEvaluator, String) - Constructor for class com.mangofactory.swagger.scanners.ApiListingScanner
 
ApiModelReader - Class in com.mangofactory.swagger.readers
 
ApiModelReader(ModelProvider) - Constructor for class com.mangofactory.swagger.readers.ApiModelReader
 
ApiOperationReader - Class in com.mangofactory.swagger.readers
 
ApiOperationReader(Collection<RequestMappingReader>) - Constructor for class com.mangofactory.swagger.readers.ApiOperationReader
 
apiVersion(String) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Sets the api version.
applicationPath() - Method in class com.mangofactory.swagger.paths.AbsoluteSwaggerPathProvider
 
applicationPath() - Method in class com.mangofactory.swagger.paths.RelativeSwaggerPathProvider
 
applicationPath() - Method in class com.mangofactory.swagger.paths.SwaggerPathProvider
For relative SwaggerPathProviders this is typically '/' meaning relative to the swagger ui page serving the documentation.
AuthorizationContext - Class in com.mangofactory.swagger.authorization
A class to represent a default set of authorizations to apply to each api operation To customize which request mappings the list of authorizations are applied to Specify the custom includePatterns or requestMethods
authorizationContext(AuthorizationContext) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Configures which api operations (via regex patterns) and HTTP methods to apply swagger authorization to.
AuthorizationContext.AuthorizationContextBuilder - Class in com.mangofactory.swagger.authorization
 
AuthorizationContext.AuthorizationContextBuilder(List<Authorization>) - Constructor for class com.mangofactory.swagger.authorization.AuthorizationContext.AuthorizationContextBuilder
 
authorizationTypes(List<AuthorizationType>) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Configures the global com.wordnik.swagger.model.AuthorizationType's applicable to all or some of the api operations.

B

build() - Method in class com.mangofactory.swagger.authorization.AuthorizationContext.AuthorizationContextBuilder
 
build() - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Builds the SwaggerSpringMvcPlugin by merging/overlaying user specified values.

C

classHasIgnoredAnnotatedRequestMapping(Class<?>) - Method in class com.mangofactory.swagger.core.RequestMappingEvaluator
 
ClassOrApiAnnotationResourceGrouping - Class in com.mangofactory.swagger.core
 
ClassOrApiAnnotationResourceGrouping() - Constructor for class com.mangofactory.swagger.core.ClassOrApiAnnotationResourceGrouping
 
com.mangofactory.swagger.annotations - package com.mangofactory.swagger.annotations
 
com.mangofactory.swagger.authorization - package com.mangofactory.swagger.authorization
 
com.mangofactory.swagger.configuration - package com.mangofactory.swagger.configuration
 
com.mangofactory.swagger.controllers - package com.mangofactory.swagger.controllers
 
com.mangofactory.swagger.core - package com.mangofactory.swagger.core
 
com.mangofactory.swagger.ordering - package com.mangofactory.swagger.ordering
 
com.mangofactory.swagger.paths - package com.mangofactory.swagger.paths
 
com.mangofactory.swagger.plugin - package com.mangofactory.swagger.plugin
 
com.mangofactory.swagger.readers - package com.mangofactory.swagger.readers
 
com.mangofactory.swagger.readers.operation - package com.mangofactory.swagger.readers.operation
 
com.mangofactory.swagger.readers.operation.parameter - package com.mangofactory.swagger.readers.operation.parameter
 
com.mangofactory.swagger.scanners - package com.mangofactory.swagger.scanners
 
Command<T> - Interface in com.mangofactory.swagger.readers
 
CommandContext<T> - Interface in com.mangofactory.swagger.core
 
CommandExecutor<T,C> - Class in com.mangofactory.swagger.core
 
CommandExecutor() - Constructor for class com.mangofactory.swagger.core.CommandExecutor
 
compare(ApiDescription, ApiDescription) - Method in class com.mangofactory.swagger.ordering.ApiDescriptionLexicographicalOrdering
 
compare(Operation, Operation) - Method in class com.mangofactory.swagger.ordering.OperationPositionalOrdering
 
compare(ApiListingReference, ApiListingReference) - Method in class com.mangofactory.swagger.ordering.ResourceListingLexicographicalOrdering
 
compare(ApiListingReference, ApiListingReference) - Method in class com.mangofactory.swagger.ordering.ResourceListingPositionalOrdering
 
ControllerNamingUtils - Class in com.mangofactory.swagger.core
 
ControllerNamingUtils() - Constructor for class com.mangofactory.swagger.core.ControllerNamingUtils
 
customAnnotationReaders(Collection<RequestMappingReader>) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Hook for adding custom annotations readers.

D

decode(String) - Static method in class com.mangofactory.swagger.core.ControllerNamingUtils
 
defaultAlternateTypeProvider() - Method in class com.mangofactory.swagger.configuration.SpringSwaggerConfig
 
defaultExcludeAnnotations() - Method in class com.mangofactory.swagger.configuration.SpringSwaggerConfig
 
defaultIgnorableParameterTypes() - Method in class com.mangofactory.swagger.configuration.SpringSwaggerConfig
 
defaultModelProvider() - Method in class com.mangofactory.swagger.configuration.SpringSwaggerConfig
 
defaultResourceGroupingStrategy() - Method in class com.mangofactory.swagger.configuration.SpringSwaggerConfig
 
DefaultResponseMessageReader - Class in com.mangofactory.swagger.readers.operation
 
DefaultResponseMessageReader() - Constructor for class com.mangofactory.swagger.readers.operation.DefaultResponseMessageReader
 
defaultResponseMessages() - Method in class com.mangofactory.swagger.configuration.SpringSwaggerConfig
Default response messages set on all api operations
DefaultSwaggerController - Class in com.mangofactory.swagger.controllers
 
DefaultSwaggerController() - Constructor for class com.mangofactory.swagger.controllers.DefaultSwaggerController
 
defaultSwaggerPathProvider() - Method in class com.mangofactory.swagger.configuration.SpringSwaggerConfig
 
directModelSubstitute(Class, Class) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Directly substitutes a model class with the supplied substitute e.g directModelSubstitute(LocalDate.class, Date.class) would substitute LocalDate with Date
DOCUMENTATION_BASE_PATH - Static variable in class com.mangofactory.swagger.controllers.DefaultSwaggerController
 

E

enable(boolean) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Hook to externally control auto initialization of this swagger plugin instance.
EnableSwagger - Annotation Type in com.mangofactory.swagger.plugin
Indicates that Swagger support should be enabled.
encode(String) - Static method in class com.mangofactory.swagger.core.ControllerNamingUtils
 
equals(Object) - Method in class com.mangofactory.swagger.scanners.ResourceGroup
 
excludeAnnotations(Class<? extends Annotation>...) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Spring controllers or request mappings with these annotations will be excluded from the generated swagger JSON.
execute(List<? extends Command<C>>, CommandContext<T>) - Method in class com.mangofactory.swagger.core.CommandExecutor
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.ApiDescriptionReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.ApiModelReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.ApiOperationReader
 
execute(T) - Method in interface com.mangofactory.swagger.readers.Command
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.MediaTypeReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.OperationAuthReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.OperationDeprecatedReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.OperationHiddenReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.OperationHttpMethodReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.OperationNicknameReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.OperationNotesReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.OperationPositionReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.OperationResponseClassReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.OperationSummaryReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.parameter.ParameterAccessReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.parameter.ParameterAllowableReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.parameter.ParameterDataTypeReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.parameter.ParameterDefaultReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.parameter.ParameterDescriptionReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.parameter.ParameterMultiplesReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.parameter.ParameterNameReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.parameter.ParameterRequiredReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.parameter.ParameterTypeReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.SwaggerParameterReader
 
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.SwaggerResponseMessageReader
Deprecated.  
execute(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.OperationParameterRequestConditionReader
 

F

firstPathSegment(String) - Static method in class com.mangofactory.swagger.core.StringUtils
 

G

genericModelSubstitutes(Class...) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Substitutes each generic class with it's direct parameterized type.
genericTypeNamingStrategy(GenericTypeNamingStrategy) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Controls how generics are encoded as swagger types, specifically around the characters used to open, close, and delimit lists of types.
get(String) - Method in class com.mangofactory.swagger.scanners.RequestMappingContext
 
getAlternateTypeProvider() - Method in class com.mangofactory.swagger.configuration.SwaggerGlobalSettings
 
getApiListing(String, String) - Method in class com.mangofactory.swagger.controllers.DefaultSwaggerController
 
getApiListingReferences() - Method in class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
 
getApiOperationAnnotation() - Method in class com.mangofactory.swagger.scanners.RequestMappingContext
 
getApiParamAnnotation() - Method in class com.mangofactory.swagger.scanners.RequestMappingContext
 
getApiResourcePrefix() - Method in class com.mangofactory.swagger.paths.SwaggerPathProvider
 
getApplicationBasePath() - Method in class com.mangofactory.swagger.paths.SwaggerPathProvider
 
getAuthorizations() - Method in class com.mangofactory.swagger.authorization.AuthorizationContext
 
getAuthorizationsForPath(String) - Method in class com.mangofactory.swagger.authorization.AuthorizationContext
 
getAuthorizationTypes() - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
getContext() - Method in class com.mangofactory.swagger.scanners.RequestMappingContext
 
getDocumentationPath() - Method in class com.mangofactory.swagger.paths.AbsoluteSwaggerPathProvider
 
getDocumentationPath() - Method in class com.mangofactory.swagger.paths.RelativeSwaggerPathProvider
 
getDocumentationPath() - Method in class com.mangofactory.swagger.paths.SwaggerPathProvider
The base path to the swagger api documentation.
getExcludeAnnotations() - Method in class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
 
getGlobalResponseMessages() - Method in class com.mangofactory.swagger.configuration.SwaggerGlobalSettings
 
getGroupName() - Method in class com.mangofactory.swagger.scanners.ResourceGroup
 
getHandlerMethod() - Method in class com.mangofactory.swagger.scanners.RequestMappingContext
 
getIgnorableParameterTypes() - Method in class com.mangofactory.swagger.configuration.SwaggerGlobalSettings
 
getImplicitParameter(ApiImplicitParam) - Static method in class com.mangofactory.swagger.readers.operation.OperationImplicitParameterReader
 
getIncludePatterns() - Method in class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
 
getMethodParameter() - Method in class com.mangofactory.swagger.readers.operation.ResolvedMethodParameter
 
getModelName(TypeResolver, Type) - Static method in class com.mangofactory.swagger.core.ModelUtils
 
getOperationPath(String) - Method in class com.mangofactory.swagger.paths.SwaggerPathProvider
The relative path to the operation, from the basePath, which this operation describes.
getPosition() - Method in class com.mangofactory.swagger.scanners.ResourceGroup
 
getRequestMappingInfo() - Method in class com.mangofactory.swagger.scanners.RequestMappingContext
 
getResolvedParameterType() - Method in class com.mangofactory.swagger.readers.operation.ResolvedMethodParameter
 
getResourceDescription(RequestMappingInfo, HandlerMethod) - Method in class com.mangofactory.swagger.core.ClassOrApiAnnotationResourceGrouping
 
getResourceDescription(RequestMappingInfo, HandlerMethod) - Method in interface com.mangofactory.swagger.core.ResourceGroupingStrategy
Gets the resource description.
getResourceDescription(RequestMappingInfo, HandlerMethod) - Method in class com.mangofactory.swagger.core.SpringGroupingStrategy
 
getResourceGroupingStrategy() - Method in class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
 
getResourceGroupRequestMappings() - Method in class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
 
getResourceGroups(RequestMappingInfo, HandlerMethod) - Method in class com.mangofactory.swagger.core.ClassOrApiAnnotationResourceGrouping
 
getResourceGroups(RequestMappingInfo, HandlerMethod) - Method in interface com.mangofactory.swagger.core.ResourceGroupingStrategy
Gets the resource group for a particular request mapping.
getResourceGroups(RequestMappingInfo, HandlerMethod) - Method in class com.mangofactory.swagger.core.SpringGroupingStrategy
 
getResourceListing(String) - Method in class com.mangofactory.swagger.controllers.DefaultSwaggerController
 
getResourceListing(String) - Method in class com.mangofactory.swagger.core.SwaggerCache
 
getResourceListingPath(String, String) - Method in class com.mangofactory.swagger.paths.SwaggerPathProvider
Corresponds to the path attribute of a swagger Resource Object (within a Resource Listing).
getResourcePosition(RequestMappingInfo, HandlerMethod) - Method in class com.mangofactory.swagger.core.ClassOrApiAnnotationResourceGrouping
 
getResourcePosition(RequestMappingInfo, HandlerMethod) - Method in interface com.mangofactory.swagger.core.ResourceGroupingStrategy
Gets the position of the resource.
getResourcePosition(RequestMappingInfo, HandlerMethod) - Method in class com.mangofactory.swagger.core.SpringGroupingStrategy
 
getResponseClassName(ResolvedType) - Static method in class com.mangofactory.swagger.core.ModelUtils
 
getResult() - Method in interface com.mangofactory.swagger.core.CommandContext
 
getResult() - Method in class com.mangofactory.swagger.scanners.RequestMappingContext
 
getScalaAuthorizations() - Method in class com.mangofactory.swagger.authorization.AuthorizationContext
 
getSwaggerApiListingMap() - Method in class com.mangofactory.swagger.core.SwaggerCache
 
getSwaggerApiResourceListingMap() - Method in class com.mangofactory.swagger.core.SwaggerCache
 
getSwaggerCache() - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
getSwaggerGlobalSettings() - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
getSwaggerGlobalSettings() - Method in class com.mangofactory.swagger.scanners.ApiListingScanner
 
getSwaggerGroup() - Method in class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
 
getSwaggerPathProvider() - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
getSwaggerPathProvider() - Method in class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
 
getTypeResolver() - Method in class com.mangofactory.swagger.configuration.SwaggerGlobalSettings
 
globalResponseMessage(RequestMethod, List<ResponseMessage>) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Overrides the default http response messages at the http request method level.

H

HandlerMethodResolver - Class in com.mangofactory.swagger.readers.operation
 
HandlerMethodResolver(TypeResolver) - Constructor for class com.mangofactory.swagger.readers.operation.HandlerMethodResolver
 
handlerReturnType(TypeResolver, HandlerMethod) - Static method in class com.mangofactory.swagger.core.ModelUtils
 
hashCode() - Method in class com.mangofactory.swagger.scanners.ResourceGroup
 
hasIgnoredAnnotatedRequestMapping(HandlerMethod) - Method in class com.mangofactory.swagger.core.RequestMappingEvaluator
 

I

ignoredParameterTypes(Class...) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Adds ignored controller method parameter types so that the framework does not generate swagger model or parameter information for these specific types.
includePatterns(String...) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Controls which controllers, more specifically, which Spring RequestMappings to include in the swagger Resource Listing.
initialize() - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
initialize() - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Called by the framework hence protected
isEnabled() - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
 

J

JacksonSwaggerSupport - Class in com.mangofactory.swagger.configuration
 
JacksonSwaggerSupport() - Constructor for class com.mangofactory.swagger.configuration.JacksonSwaggerSupport
 
jacksonSwaggerSupport() - Method in class com.mangofactory.swagger.configuration.SpringSwaggerConfig
Registers some custom serializers needed to transform swagger models to swagger-ui required json format.

M

maybeChompLeadingSlash(String) - Static method in class com.mangofactory.swagger.core.StringUtils
 
maybeChompTrailingSlash(String) - Static method in class com.mangofactory.swagger.core.StringUtils
 
MediaTypeReader - Class in com.mangofactory.swagger.readers
 
MediaTypeReader() - Constructor for class com.mangofactory.swagger.readers.MediaTypeReader
 
methodParameters(HandlerMethod) - Method in class com.mangofactory.swagger.readers.operation.HandlerMethodResolver
 
methodReturnType(Method, Class<?>) - Method in class com.mangofactory.swagger.readers.operation.HandlerMethodResolver
Resolves the return type of the given method in the class.
modelProvider(ModelProvider) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Overrides the default com.mangofactory.swagger.models.ModelProvider
ModelUtils - Class in com.mangofactory.swagger.core
 

O

onApplicationEvent(ContextRefreshedEvent) - Method in class com.mangofactory.swagger.plugin.SwaggerPluginAdapter
 
OPERATION_POSITIONAL_ORDERING - Static variable in class com.mangofactory.swagger.readers.ApiOperationReader
 
OperationAuthReader - Class in com.mangofactory.swagger.readers.operation
 
OperationAuthReader() - Constructor for class com.mangofactory.swagger.readers.operation.OperationAuthReader
 
OperationDeprecatedReader - Class in com.mangofactory.swagger.readers.operation
 
OperationDeprecatedReader() - Constructor for class com.mangofactory.swagger.readers.operation.OperationDeprecatedReader
 
OperationHiddenReader - Class in com.mangofactory.swagger.readers.operation
 
OperationHiddenReader() - Constructor for class com.mangofactory.swagger.readers.operation.OperationHiddenReader
 
OperationHttpMethodReader - Class in com.mangofactory.swagger.readers.operation
 
OperationHttpMethodReader() - Constructor for class com.mangofactory.swagger.readers.operation.OperationHttpMethodReader
 
OperationImplicitParameterReader - Class in com.mangofactory.swagger.readers.operation
 
OperationImplicitParameterReader() - Constructor for class com.mangofactory.swagger.readers.operation.OperationImplicitParameterReader
 
OperationImplicitParametersReader - Class in com.mangofactory.swagger.readers.operation
 
OperationImplicitParametersReader() - Constructor for class com.mangofactory.swagger.readers.operation.OperationImplicitParametersReader
 
OperationNicknameReader - Class in com.mangofactory.swagger.readers.operation
 
OperationNicknameReader() - Constructor for class com.mangofactory.swagger.readers.operation.OperationNicknameReader
 
OperationNotesReader - Class in com.mangofactory.swagger.readers.operation
 
OperationNotesReader() - Constructor for class com.mangofactory.swagger.readers.operation.OperationNotesReader
 
OperationParameterReader - Class in com.mangofactory.swagger.readers.operation.parameter
 
OperationParameterReader() - Constructor for class com.mangofactory.swagger.readers.operation.parameter.OperationParameterReader
 
OperationParameterRequestConditionReader - Class in com.mangofactory.swagger.readers
 
OperationParameterRequestConditionReader() - Constructor for class com.mangofactory.swagger.readers.OperationParameterRequestConditionReader
 
OperationPositionalOrdering - Class in com.mangofactory.swagger.ordering
 
OperationPositionalOrdering() - Constructor for class com.mangofactory.swagger.ordering.OperationPositionalOrdering
 
OperationPositionReader - Class in com.mangofactory.swagger.readers.operation
 
OperationPositionReader() - Constructor for class com.mangofactory.swagger.readers.operation.OperationPositionReader
 
OperationResponseClassReader - Class in com.mangofactory.swagger.readers.operation
 
OperationResponseClassReader() - Constructor for class com.mangofactory.swagger.readers.operation.OperationResponseClassReader
 
OperationSummaryReader - Class in com.mangofactory.swagger.readers.operation
 
OperationSummaryReader() - Constructor for class com.mangofactory.swagger.readers.operation.OperationSummaryReader
 

P

ParameterAccessReader - Class in com.mangofactory.swagger.readers.operation.parameter
 
ParameterAccessReader() - Constructor for class com.mangofactory.swagger.readers.operation.parameter.ParameterAccessReader
 
ParameterAllowableReader - Class in com.mangofactory.swagger.readers.operation.parameter
 
ParameterAllowableReader() - Constructor for class com.mangofactory.swagger.readers.operation.parameter.ParameterAllowableReader
 
ParameterDataTypeReader - Class in com.mangofactory.swagger.readers.operation.parameter
 
ParameterDataTypeReader() - Constructor for class com.mangofactory.swagger.readers.operation.parameter.ParameterDataTypeReader
 
ParameterDefaultReader - Class in com.mangofactory.swagger.readers.operation.parameter
 
ParameterDefaultReader() - Constructor for class com.mangofactory.swagger.readers.operation.parameter.ParameterDefaultReader
 
ParameterDescriptionReader - Class in com.mangofactory.swagger.readers.operation.parameter
 
ParameterDescriptionReader() - Constructor for class com.mangofactory.swagger.readers.operation.parameter.ParameterDescriptionReader
 
ParameterMultiplesReader - Class in com.mangofactory.swagger.readers.operation.parameter
 
ParameterMultiplesReader() - Constructor for class com.mangofactory.swagger.readers.operation.parameter.ParameterMultiplesReader
 
ParameterNameReader - Class in com.mangofactory.swagger.readers.operation.parameter
 
ParameterNameReader() - Constructor for class com.mangofactory.swagger.readers.operation.parameter.ParameterNameReader
 
ParameterRequiredReader - Class in com.mangofactory.swagger.readers.operation.parameter
 
ParameterRequiredReader() - Constructor for class com.mangofactory.swagger.readers.operation.parameter.ParameterRequiredReader
 
ParameterTypeReader - Class in com.mangofactory.swagger.readers.operation.parameter
 
ParameterTypeReader() - Constructor for class com.mangofactory.swagger.readers.operation.parameter.ParameterTypeReader
 
pathMatchesOneOfIncluded(String, List<String>) - Method in class com.mangofactory.swagger.scanners.AntRequestMappingPatternMatcher
 
pathMatchesOneOfIncluded(String, List<String>) - Method in class com.mangofactory.swagger.scanners.RegexRequestMappingPatternMatcher
 
pathMatchesOneOfIncluded(String, List<String>) - Method in interface com.mangofactory.swagger.scanners.RequestMappingPatternMatcher
 
pathProvider(SwaggerPathProvider) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Determines the generated, swagger specific, urls.
pathRoot(String) - Static method in class com.mangofactory.swagger.core.ControllerNamingUtils
 
pathRootEncoded(String) - Static method in class com.mangofactory.swagger.core.ControllerNamingUtils
 
patternConditionsMatchOneOfIncluded(PatternsRequestCondition, List<String>) - Method in class com.mangofactory.swagger.scanners.AntRequestMappingPatternMatcher
 
patternConditionsMatchOneOfIncluded(PatternsRequestCondition, List<String>) - Method in class com.mangofactory.swagger.scanners.RegexRequestMappingPatternMatcher
 
patternConditionsMatchOneOfIncluded(PatternsRequestCondition, List<String>) - Method in interface com.mangofactory.swagger.scanners.RequestMappingPatternMatcher
 
put(String, Object) - Method in class com.mangofactory.swagger.scanners.RequestMappingContext
 

R

read(SwaggerGlobalSettings, RequestMethod, HandlerMethod) - Method in class com.mangofactory.swagger.readers.operation.DefaultResponseMessageReader
 
read(SwaggerGlobalSettings, RequestMethod, HandlerMethod) - Method in class com.mangofactory.swagger.readers.operation.SwaggerResponseMessageReader
Deprecated.  
readParameters(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.OperationImplicitParameterReader
 
readParameters(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.OperationImplicitParametersReader
 
readParameters(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.parameter.OperationParameterReader
 
readParameters(RequestMappingContext) - Method in class com.mangofactory.swagger.readers.operation.SwaggerParameterReader
 
RegexRequestMappingPatternMatcher - Class in com.mangofactory.swagger.scanners
 
RegexRequestMappingPatternMatcher() - Constructor for class com.mangofactory.swagger.scanners.RegexRequestMappingPatternMatcher
 
RelativeSwaggerPathProvider - Class in com.mangofactory.swagger.paths
 
RelativeSwaggerPathProvider(ServletContext) - Constructor for class com.mangofactory.swagger.paths.RelativeSwaggerPathProvider
 
RequestMappingContext - Class in com.mangofactory.swagger.scanners
 
RequestMappingContext(RequestMappingInfo, HandlerMethod) - Constructor for class com.mangofactory.swagger.scanners.RequestMappingContext
 
RequestMappingEvaluator - Class in com.mangofactory.swagger.core
 
RequestMappingEvaluator(List<Class<? extends Annotation>>, RequestMappingPatternMatcher, List<String>) - Constructor for class com.mangofactory.swagger.core.RequestMappingEvaluator
 
requestMappingPatternMatcher(RequestMappingPatternMatcher) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Hook for adding custom annotations readers.
RequestMappingPatternMatcher - Interface in com.mangofactory.swagger.scanners
 
RequestMappingReader - Interface in com.mangofactory.swagger.readers.operation
 
ResolvedMethodParameter - Class in com.mangofactory.swagger.readers.operation
 
ResolvedMethodParameter(MethodParameter, ResolvedType) - Constructor for class com.mangofactory.swagger.readers.operation.ResolvedMethodParameter
 
ResourceGroup - Class in com.mangofactory.swagger.scanners
 
ResourceGroup(String) - Constructor for class com.mangofactory.swagger.scanners.ResourceGroup
 
ResourceGroup(String, Integer) - Constructor for class com.mangofactory.swagger.scanners.ResourceGroup
 
ResourceGroupingStrategy - Interface in com.mangofactory.swagger.core
 
resourceGroupingStrategy(ResourceGroupingStrategy) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Controls which ResourceListing's, RequestMappings belong to.
ResourceListingLexicographicalOrdering - Class in com.mangofactory.swagger.ordering
Orders ApiListingReference's Lexicographically by their paths
ResourceListingLexicographicalOrdering() - Constructor for class com.mangofactory.swagger.ordering.ResourceListingLexicographicalOrdering
 
ResourceListingPositionalOrdering - Class in com.mangofactory.swagger.ordering
Orders ApiListingReference's by their position
ResourceListingPositionalOrdering() - Constructor for class com.mangofactory.swagger.ordering.ResourceListingPositionalOrdering
 
ROOT - Static variable in class com.mangofactory.swagger.paths.RelativeSwaggerPathProvider
 

S

sanitiseUrl(String) - Method in class com.mangofactory.swagger.paths.SwaggerPathProvider
 
sanitizeRequestMappingPattern(String) - Method in class com.mangofactory.swagger.readers.ApiDescriptionReader
Gets a uri friendly path from a request mapping pattern.
scan() - Method in class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
 
scan() - Method in class com.mangofactory.swagger.scanners.ApiListingScanner
 
scanSpringRequestMappings() - Method in class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
 
setAlternateTypeProvider(AlternateTypeProvider) - Method in class com.mangofactory.swagger.configuration.SwaggerGlobalSettings
 
setApiDescriptionOrdering(Ordering<ApiDescription>) - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
setApiDescriptionOrdering(Ordering<ApiDescription>) - Method in class com.mangofactory.swagger.scanners.ApiListingScanner
 
setApiInfo(ApiInfo) - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
setApiListingReferenceOrdering(Ordering<ApiListingReference>) - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
setApiListingReferenceScanner(ApiListingReferenceScanner) - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
setApiResourcePrefix(String) - Method in class com.mangofactory.swagger.paths.SwaggerPathProvider
 
setApiVersion(String) - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
setApplicationContext(ApplicationContext) - Method in class com.mangofactory.swagger.configuration.JacksonSwaggerSupport
 
setAuthorizationContext(AuthorizationContext) - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
setAuthorizationContext(AuthorizationContext) - Method in class com.mangofactory.swagger.scanners.ApiListingScanner
 
setAuthorizationTypes(List<AuthorizationType>) - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
setCustomAnnotationReaders(Collection<RequestMappingReader>) - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
setExcludeAnnotations(List<Class<? extends Annotation>>) - Method in class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
Deprecated. 
setGlobalResponseMessages(Map<RequestMethod, List<ResponseMessage>>) - Method in class com.mangofactory.swagger.configuration.SwaggerGlobalSettings
 
setIgnorableParameterTypes(Set<Class>) - Method in class com.mangofactory.swagger.configuration.SwaggerGlobalSettings
 
setIncludePatterns(List<String>) - Method in class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
Deprecated. 
setModelProvider(ModelProvider) - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
setPosition(Integer) - Method in class com.mangofactory.swagger.scanners.ResourceGroup
 
setRequestMappingEvaluator(RequestMappingEvaluator) - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
setRequestMappingEvaluator(RequestMappingEvaluator) - Method in class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
 
setRequestMappingHandlerAdapter(RequestMappingHandlerAdapter[]) - Method in class com.mangofactory.swagger.configuration.JacksonSwaggerSupport
 
setRequestMappingHandlerMapping(List<RequestMappingHandlerMapping>) - Method in class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
 
setResourceGroupingStrategy(ResourceGroupingStrategy) - Method in class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
 
setResourceGroupingStrategy(ResourceGroupingStrategy) - Method in class com.mangofactory.swagger.scanners.ApiListingScanner
Deprecated. 
setSwaggerGlobalSettings(SwaggerGlobalSettings) - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
setSwaggerGlobalSettings(SwaggerGlobalSettings) - Method in class com.mangofactory.swagger.scanners.ApiListingScanner
 
setSwaggerGroup(String) - Method in class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
 
setSwaggerPathProvider(SwaggerPathProvider) - Method in class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
setSwaggerPathProvider(SwaggerPathProvider) - Method in class com.mangofactory.swagger.scanners.ApiListingReferenceScanner
 
setup() - Method in class com.mangofactory.swagger.configuration.JacksonSwaggerSupport
 
shouldIncludePath(String) - Method in class com.mangofactory.swagger.core.RequestMappingEvaluator
 
shouldIncludeRequestMapping(RequestMappingInfo, HandlerMethod) - Method in class com.mangofactory.swagger.core.RequestMappingEvaluator
 
splitCamelCase(String, String) - Static method in class com.mangofactory.swagger.core.StringUtils
 
SpringGroupingStrategy - Class in com.mangofactory.swagger.core
TODO - fix or remove There are a lot of cases this strategy does not cover.
SpringGroupingStrategy() - Constructor for class com.mangofactory.swagger.core.SpringGroupingStrategy
 
SpringSwaggerConfig - Class in com.mangofactory.swagger.configuration
 
SpringSwaggerConfig() - Constructor for class com.mangofactory.swagger.configuration.SpringSwaggerConfig
 
StringUtils - Class in com.mangofactory.swagger.core
 
StringUtils() - Constructor for class com.mangofactory.swagger.core.StringUtils
 
SwaggerApiResourceListing - Class in com.mangofactory.swagger.core
 
SwaggerApiResourceListing(SwaggerCache, String) - Constructor for class com.mangofactory.swagger.core.SwaggerApiResourceListing
 
swaggerCache() - Method in class com.mangofactory.swagger.configuration.SpringSwaggerConfig
 
SwaggerCache - Class in com.mangofactory.swagger.core
 
SwaggerCache() - Constructor for class com.mangofactory.swagger.core.SwaggerCache
 
SwaggerGlobalSettings - Class in com.mangofactory.swagger.configuration
 
SwaggerGlobalSettings() - Constructor for class com.mangofactory.swagger.configuration.SwaggerGlobalSettings
 
swaggerGroup(String) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
If more than one instance of SwaggerSpringMvcPlugin exists, each one must have a unique swaggerGroup as supplied by this method.
SwaggerParameterReader - Class in com.mangofactory.swagger.readers.operation
 
SwaggerParameterReader() - Constructor for class com.mangofactory.swagger.readers.operation.SwaggerParameterReader
 
SwaggerPathProvider - Class in com.mangofactory.swagger.paths
 
SwaggerPathProvider() - Constructor for class com.mangofactory.swagger.paths.SwaggerPathProvider
 
swaggerPluginAdapter() - Method in class com.mangofactory.swagger.configuration.SpringSwaggerConfig
 
SwaggerPluginAdapter - Class in com.mangofactory.swagger.plugin
After an application context refresh, builds and executes all SwaggerSpringMvcPlugin instances found in the application context.
SwaggerPluginAdapter(SpringSwaggerConfig) - Constructor for class com.mangofactory.swagger.plugin.SwaggerPluginAdapter
 
swaggerRequestMappingHandlerMappings() - Method in class com.mangofactory.swagger.configuration.SpringSwaggerConfig
 
SwaggerResponseMessageReader - Class in com.mangofactory.swagger.readers.operation
Deprecated. 
SwaggerResponseMessageReader() - Constructor for class com.mangofactory.swagger.readers.operation.SwaggerResponseMessageReader
Deprecated.  
SwaggerSpringMvcPlugin - Class in com.mangofactory.swagger.plugin
A builder which is intended to be the primary interface into the swagger-springmvc framework.
SwaggerSpringMvcPlugin(SpringSwaggerConfig) - Constructor for class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Default constructor.

T

toString() - Method in class com.mangofactory.swagger.scanners.ResourceGroup
 

U

use(Class) - Static method in class com.mangofactory.swagger.readers.operation.HandlerMethodResolver
 
useDefaultResponseMessages(boolean) - Method in class com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin
Allows ignoring predefined response message defaults

W

withIncludePatterns(List<String>) - Method in class com.mangofactory.swagger.authorization.AuthorizationContext.AuthorizationContextBuilder
 
withRequestMappingPatternMatcher(RequestMappingPatternMatcher) - Method in class com.mangofactory.swagger.authorization.AuthorizationContext.AuthorizationContextBuilder
 
withRequestMethods(RequestMethod[]) - Method in class com.mangofactory.swagger.authorization.AuthorizationContext.AuthorizationContextBuilder
 

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