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

A

AbstractOperationParameterRequestConditionReader - Class in springfox.documentation.spring.web.readers.operation
 
AbstractOperationParameterRequestConditionReader(TypeResolver) - Constructor for class springfox.documentation.spring.web.readers.operation.AbstractOperationParameterRequestConditionReader
 
AbstractPathProvider - Class in springfox.documentation.spring.web.paths
 
AbstractPathProvider() - Constructor for class springfox.documentation.spring.web.paths.AbstractPathProvider
 
add(Method, ApiDescription) - Method in class springfox.documentation.spring.web.scanners.ApiDescriptionLookup
 
addDocumentation(Documentation) - Method in class springfox.documentation.spring.web.DocumentationCache
 
additionalModels(ResolvedType, ResolvedType...) - Method in class springfox.documentation.spring.web.plugins.Docket
Method to add additional models that are not part of any annotation or are perhaps implicit
adjustedPath(String) - Method in class springfox.documentation.spring.web.paths.PathMappingAdjuster
 
all() - Method in class springfox.documentation.spring.web.DocumentationCache
 
alternateTypeRules(AlternateTypeRule...) - Method in class springfox.documentation.spring.web.plugins.Docket
Adds model substitution rules (alternateTypeRules)
ApiDescriptionLookup - Class in springfox.documentation.spring.web.scanners
Given a handler method this class serves to lookup the api description.
ApiDescriptionLookup() - Constructor for class springfox.documentation.spring.web.scanners.ApiDescriptionLookup
 
apiDescriptionOrdering(Ordering<ApiDescription>) - Method in class springfox.documentation.spring.web.plugins.Docket
Controls how com.wordnik.swagger.model.ApiDescription's are ordered.
apiDescriptionOrdering() - Method in class springfox.documentation.spring.web.scanners.ApiListingScanningContext
 
ApiDescriptionReader - Class in springfox.documentation.spring.web.scanners
 
ApiDescriptionReader(OperationReader, DocumentationPluginsManager, ApiDescriptionLookup) - Constructor for class springfox.documentation.spring.web.scanners.ApiDescriptionReader
 
ApiDocumentationScanner - Class in springfox.documentation.spring.web.scanners
 
ApiDocumentationScanner(ApiListingReferenceScanner, ApiListingScanner) - Constructor for class springfox.documentation.spring.web.scanners.ApiDocumentationScanner
 
apiInfo(ApiInfo) - Method in class springfox.documentation.spring.web.plugins.Docket
Sets the api's meta information as included in the json ResourceListing response.
apiListing(ApiListingContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 
ApiListingReader - Class in springfox.documentation.spring.web.scanners
 
ApiListingReader() - Constructor for class springfox.documentation.spring.web.scanners.ApiListingReader
 
apiListingReferenceOrdering(Ordering<ApiListingReference>) - Method in class springfox.documentation.spring.web.plugins.Docket
Controls how ApiListingReference's are sorted.
ApiListingReferenceScanner - Class in springfox.documentation.spring.web.scanners
 
ApiListingReferenceScanner() - Constructor for class springfox.documentation.spring.web.scanners.ApiListingReferenceScanner
 
ApiListingReferenceScanResult - Class in springfox.documentation.spring.web.scanners
 
ApiListingReferenceScanResult(Map<ResourceGroup, List<RequestMappingContext>>) - Constructor for class springfox.documentation.spring.web.scanners.ApiListingReferenceScanResult
 
ApiListingScanner - Class in springfox.documentation.spring.web.scanners
 
ApiListingScanner(ApiDescriptionReader, ApiModelReader, DocumentationPluginsManager) - Constructor for class springfox.documentation.spring.web.scanners.ApiListingScanner
 
ApiListingScanningContext - Class in springfox.documentation.spring.web.scanners
 
ApiListingScanningContext(DocumentationContext, Map<ResourceGroup, List<RequestMappingContext>>) - Constructor for class springfox.documentation.spring.web.scanners.ApiListingScanningContext
 
ApiModelReader - Class in springfox.documentation.spring.web.scanners
 
ApiModelReader(ModelProvider, TypeResolver, DocumentationPluginsManager) - Constructor for class springfox.documentation.spring.web.scanners.ApiModelReader
 
ApiOperationReader - Class in springfox.documentation.spring.web.readers.operation
 
ApiOperationReader(DocumentationPluginsManager, OperationNameGenerator) - Constructor for class springfox.documentation.spring.web.readers.operation.ApiOperationReader
 
apis(Predicate<RequestHandler>) - Method in class springfox.documentation.spring.web.plugins.ApiSelectorBuilder
 
ApiSelectorBuilder - Class in springfox.documentation.spring.web.plugins
 
ApiSelectorBuilder(Docket) - Constructor for class springfox.documentation.spring.web.plugins.ApiSelectorBuilder
 
applicationPath() - Method in class springfox.documentation.spring.web.paths.AbstractPathProvider
For relative PathProviders this is typically '/' meaning relative to the swagger ui page serving the documentation.
applicationPath() - Method in class springfox.documentation.spring.web.paths.RelativePathProvider
 
apply(OperationContext) - Method in class springfox.documentation.spring.web.readers.operation.DefaultOperationReader
 
apply(OperationContext) - Method in class springfox.documentation.spring.web.readers.operation.OperationDeprecatedReader
 
apply(RequestMappingContext) - Method in class springfox.documentation.spring.web.readers.operation.OperationModelsProvider
 
apply(OperationContext) - Method in class springfox.documentation.spring.web.readers.operation.OperationParameterHeadersConditionReader
 
apply(OperationContext) - Method in class springfox.documentation.spring.web.readers.operation.OperationParameterReader
 
apply(OperationContext) - Method in class springfox.documentation.spring.web.readers.operation.OperationParameterRequestConditionReader
 
apply(OperationContext) - Method in class springfox.documentation.spring.web.readers.operation.OperationResponseClassReader
 
apply(OperationContext) - Method in class springfox.documentation.spring.web.readers.operation.OperationTagsReader
 
apply(OperationContext) - Method in class springfox.documentation.spring.web.readers.operation.ResponseMessagesReader
 
apply(ParameterExpansionContext) - Method in class springfox.documentation.spring.web.readers.parameter.ExpandedParameterBuilder
 
apply(ParameterContext) - Method in class springfox.documentation.spring.web.readers.parameter.ParameterDataTypeReader
 
apply(ParameterContext) - Method in class springfox.documentation.spring.web.readers.parameter.ParameterDefaultReader
 
apply(ParameterContext) - Method in class springfox.documentation.spring.web.readers.parameter.ParameterMultiplesReader
 
apply(ParameterContext) - Method in class springfox.documentation.spring.web.readers.parameter.ParameterNameReader
 
apply(ParameterContext) - Method in class springfox.documentation.spring.web.readers.parameter.ParameterRequiredReader
 
apply(ParameterContext) - Method in class springfox.documentation.spring.web.readers.parameter.ParameterTypeReader
 
apply(ApiListingContext) - Method in class springfox.documentation.spring.web.scanners.ApiListingReader
 
apply(OperationContext) - Method in class springfox.documentation.spring.web.scanners.MediaTypeReader
 
apply(ApiListingContext) - Method in class springfox.documentation.spring.web.scanners.MediaTypeReader
 

B

build() - Method in class springfox.documentation.spring.web.plugins.ApiSelectorBuilder
 

C

CachingOperationNameGenerator - Class in springfox.documentation.spring.web.readers.operation
 
CachingOperationNameGenerator() - Constructor for class springfox.documentation.spring.web.readers.operation.CachingOperationNameGenerator
 
CachingOperationReader - Class in springfox.documentation.spring.web.scanners
 
CachingOperationReader(OperationReader) - Constructor for class springfox.documentation.spring.web.scanners.CachingOperationReader
 
clear() - Method in class springfox.documentation.spring.web.DocumentationCache
 
configure(DocumentationContextBuilder) - Method in class springfox.documentation.spring.web.plugins.Docket
Builds the Docket by merging/overlaying user specified values.
consumes(Set<String>) - Method in class springfox.documentation.spring.web.plugins.Docket
 
controllerNameAsGroup(HandlerMethod) - Static method in class springfox.documentation.spring.web.ControllerNamingUtils
 
ControllerNamingUtils - Class in springfox.documentation.spring.web
 
ControllerNamingUtils() - Constructor for class springfox.documentation.spring.web.ControllerNamingUtils
 
create(DocumentationType) - Method in class springfox.documentation.spring.web.plugins.DefaultConfiguration
 
createContextBuilder(DocumentationType, DefaultConfiguration) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 

D

decode(String) - Static method in class springfox.documentation.spring.web.ControllerNamingUtils
 
decorator(PathContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 
DEFAULT_GROUP_NAME - Static variable in class springfox.documentation.spring.web.plugins.Docket
 
DefaultConfiguration - Class in springfox.documentation.spring.web.plugins
 
DefaultConfiguration(Defaults, TypeResolver, ServletContext) - Constructor for class springfox.documentation.spring.web.plugins.DefaultConfiguration
 
DefaultOperationReader - Class in springfox.documentation.spring.web.readers.operation
 
DefaultOperationReader() - Constructor for class springfox.documentation.spring.web.readers.operation.DefaultOperationReader
 
defaults() - Method in class springfox.documentation.spring.web.SpringfoxWebMvcConfiguration
 
DefaultTagsProvider - Class in springfox.documentation.spring.web.readers.operation
 
DefaultTagsProvider() - Constructor for class springfox.documentation.spring.web.readers.operation.DefaultTagsProvider
 
description(Method) - Method in class springfox.documentation.spring.web.scanners.ApiDescriptionLookup
 
directModelSubstitute(Class, Class) - Method in class springfox.documentation.spring.web.plugins.Docket
Directly substitutes a model class with the supplied substitute e.g directModelSubstitute(LocalDate.class, Date.class) would substitute LocalDate with Date
Docket - Class in springfox.documentation.spring.web.plugins
A builder which is intended to be the primary interface into the swagger-springmvc framework.
Docket(DocumentationType) - Constructor for class springfox.documentation.spring.web.plugins.Docket
 
documentationByGroup(String) - Method in class springfox.documentation.spring.web.DocumentationCache
 
DocumentationCache - Class in springfox.documentation.spring.web
 
DocumentationCache() - Constructor for class springfox.documentation.spring.web.DocumentationCache
 
documentationPlugins() - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 
DocumentationPluginsBootstrapper - Class in springfox.documentation.spring.web.plugins
After an application context refresh, builds and executes all DocumentationConfigurer instances found in the application context.
DocumentationPluginsBootstrapper(DocumentationPluginsManager, List<RequestHandlerProvider>, DocumentationCache, ApiDocumentationScanner, TypeResolver, Defaults, ServletContext) - Constructor for class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
 
DocumentationPluginsManager - Class in springfox.documentation.spring.web.plugins
 
DocumentationPluginsManager() - Constructor for class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 
doEquivalent(RequestMappingContext, RequestMappingContext) - Method in class springfox.documentation.spring.web.OperationCachingEquivalence
 
doHash(RequestMappingContext) - Method in class springfox.documentation.spring.web.OperationCachingEquivalence
 

E

enable(boolean) - Method in class springfox.documentation.spring.web.plugins.Docket
Hook to externally control auto initialization of this swagger plugin instance.
enableUrlTemplating(boolean) - Method in class springfox.documentation.spring.web.plugins.Docket
Decides whether to use url templating for paths.
encode(String) - Static method in class springfox.documentation.spring.web.ControllerNamingUtils
 
expand(String, Class<?>, List<Parameter>, DocumentationContext) - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterExpander
 
ExpandedParameterBuilder - Class in springfox.documentation.spring.web.readers.parameter
 
ExpandedParameterBuilder(TypeResolver) - Constructor for class springfox.documentation.spring.web.readers.parameter.ExpandedParameterBuilder
 
expandParameter(ParameterExpansionContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 

F

findParameterType(ParameterContext) - Static method in class springfox.documentation.spring.web.readers.parameter.ParameterTypeReader
 
firstPathSegment(String) - Static method in class springfox.documentation.spring.web.paths.Paths
 
forCodeGeneration(boolean) - Method in class springfox.documentation.spring.web.plugins.Docket
Set this to true in order to make the documentation code generation friendly

G

genericModelSubstitutes(Class...) - Method in class springfox.documentation.spring.web.plugins.Docket
Substitutes each generic class with it's direct parameterized type.
getApplicationBasePath() - Method in class springfox.documentation.spring.web.paths.AbstractPathProvider
 
getDocumentationContext() - Method in class springfox.documentation.spring.web.scanners.ApiListingScanningContext
 
getDocumentationPath() - Method in class springfox.documentation.spring.web.paths.AbstractPathProvider
The base path to the swagger api documentation.
getDocumentationPath() - Method in class springfox.documentation.spring.web.paths.RelativePathProvider
 
getDocumentationType() - Method in class springfox.documentation.spring.web.plugins.Docket
 
getDocumentationType() - Method in class springfox.documentation.spring.web.scanners.ApiListingScanningContext
 
getField() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeField
 
getFieldType() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeField
 
getGroupName() - Method in class springfox.documentation.spring.web.plugins.Docket
 
getOperationPath(String) - Method in class springfox.documentation.spring.web.paths.AbstractPathProvider
The relative path to the operation, from the basePath, which this operation describes.
getParameters(Set<NameValueExpression<String>>, String) - Method in class springfox.documentation.spring.web.readers.operation.AbstractOperationParameterRequestConditionReader
 
getPhase() - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
 
getRequestMappingsByResourceGroup() - Method in class springfox.documentation.spring.web.scanners.ApiListingScanningContext
 
getResourceDescription(RequestMappingInfo, HandlerMethod) - Method in class springfox.documentation.spring.web.SpringGroupingStrategy
 
getResourceGroupRequestMappings() - Method in class springfox.documentation.spring.web.scanners.ApiListingReferenceScanResult
 
getResourceGroups(RequestMappingInfo, HandlerMethod) - Method in class springfox.documentation.spring.web.SpringGroupingStrategy
 
getResourceListingPath(String, String) - Method in class springfox.documentation.spring.web.paths.AbstractPathProvider
Corresponds to the path attribute of a swagger Resource Object (within a Resource Listing).
getResourcePosition(RequestMappingInfo, HandlerMethod) - Method in class springfox.documentation.spring.web.SpringGroupingStrategy
 
globalOperationParameters(List<Parameter>) - Method in class springfox.documentation.spring.web.plugins.Docket
Adds default parameters which will be applied to all operations.
globalResponseMessage(RequestMethod, List<ResponseMessage>) - Method in class springfox.documentation.spring.web.plugins.Docket
Overrides the default http response messages at the http request method level.
groupName(String) - Method in class springfox.documentation.spring.web.plugins.Docket
If more than one instance of Docket exists, each one must have a unique groupName as supplied by this method.

H

HandlerMethodResolver - Class in springfox.documentation.spring.web.readers.operation
 
HandlerMethodResolver(TypeResolver) - Constructor for class springfox.documentation.spring.web.readers.operation.HandlerMethodResolver
 
host(String) - Method in class springfox.documentation.spring.web.plugins.Docket
 
httpStatusCode(HandlerMethod) - Static method in class springfox.documentation.spring.web.readers.operation.ResponseMessagesReader
 

I

ignoredParameterTypes(Class...) - Method in class springfox.documentation.spring.web.plugins.Docket
Adds ignored controller method parameter types so that the framework does not generate swagger model or parameter information for these specific types.
isAutoStartup() - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
 
isEnabled() - Method in class springfox.documentation.spring.web.plugins.Docket
 
isRunning() - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
 

J

JacksonModuleRegistrar - Interface in springfox.documentation.spring.web.json
 
Json - Class in springfox.documentation.spring.web.json
 
Json(String) - Constructor for class springfox.documentation.spring.web.json.Json
 
JsonSerializer - Class in springfox.documentation.spring.web.json
 
JsonSerializer(List<JacksonModuleRegistrar>) - Constructor for class springfox.documentation.spring.web.json.JsonSerializer
 
jsonSerializer(List<JacksonModuleRegistrar>) - Method in class springfox.documentation.spring.web.SpringfoxWebMvcConfiguration
 

M

maybeChompLeadingSlash(String) - Static method in class springfox.documentation.spring.web.paths.Paths
 
maybeChompTrailingSlash(String) - Static method in class springfox.documentation.spring.web.paths.Paths
 
maybeRegisterModule(ObjectMapper) - Method in interface springfox.documentation.spring.web.json.JacksonModuleRegistrar
 
MediaTypeReader - Class in springfox.documentation.spring.web.scanners
 
MediaTypeReader(TypeResolver) - Constructor for class springfox.documentation.spring.web.scanners.MediaTypeReader
 
message(HandlerMethod) - Static method in class springfox.documentation.spring.web.readers.operation.ResponseMessagesReader
 
methodParameters(HandlerMethod) - Method in class springfox.documentation.spring.web.readers.operation.HandlerMethodResolver
 
methodReturnType(HandlerMethod) - Method in class springfox.documentation.spring.web.readers.operation.HandlerMethodResolver
 
ModelAttributeField - Class in springfox.documentation.spring.web.readers.parameter
 
ModelAttributeField(Class<?>, Field) - Constructor for class springfox.documentation.spring.web.readers.parameter.ModelAttributeField
 
ModelAttributeParameterExpander - Class in springfox.documentation.spring.web.readers.parameter
 
ModelAttributeParameterExpander(TypeResolver) - Constructor for class springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterExpander
 
modelContexts(RequestMappingContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 

O

ObjectMapperConfigurer - Class in springfox.documentation.spring.web
 
ObjectMapperConfigurer() - Constructor for class springfox.documentation.spring.web.ObjectMapperConfigurer
 
objectMapperConfigurer() - Static method in class springfox.documentation.spring.web.SpringfoxWebMvcConfiguration
 
operation(OperationContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 
OperationCachingEquivalence - Class in springfox.documentation.spring.web
 
OperationCachingEquivalence() - Constructor for class springfox.documentation.spring.web.OperationCachingEquivalence
 
OperationDeprecatedReader - Class in springfox.documentation.spring.web.readers.operation
 
OperationDeprecatedReader() - Constructor for class springfox.documentation.spring.web.readers.operation.OperationDeprecatedReader
 
OperationModelsProvider - Class in springfox.documentation.spring.web.readers.operation
 
OperationModelsProvider(TypeResolver) - Constructor for class springfox.documentation.spring.web.readers.operation.OperationModelsProvider
 
operationOrdering(Ordering<Operation>) - Method in class springfox.documentation.spring.web.plugins.Docket
Provide an ordering schema for operations

NOTE: @see #732 in case you're wondering why specifying position might not work.

OperationParameterHeadersConditionReader - Class in springfox.documentation.spring.web.readers.operation
 
OperationParameterHeadersConditionReader(TypeResolver) - Constructor for class springfox.documentation.spring.web.readers.operation.OperationParameterHeadersConditionReader
 
OperationParameterReader - Class in springfox.documentation.spring.web.readers.operation
 
OperationParameterReader(TypeResolver, ModelAttributeParameterExpander) - Constructor for class springfox.documentation.spring.web.readers.operation.OperationParameterReader
 
OperationParameterRequestConditionReader - Class in springfox.documentation.spring.web.readers.operation
 
OperationParameterRequestConditionReader(TypeResolver) - Constructor for class springfox.documentation.spring.web.readers.operation.OperationParameterRequestConditionReader
 
OperationReader - Interface in springfox.documentation.spring.web.readers.operation
 
OperationResponseClassReader - Class in springfox.documentation.spring.web.readers.operation
 
OperationResponseClassReader(TypeResolver, TypeNameExtractor) - Constructor for class springfox.documentation.spring.web.readers.operation.OperationResponseClassReader
 
OperationTagsReader - Class in springfox.documentation.spring.web.readers.operation
 
OperationTagsReader(DefaultTagsProvider) - Constructor for class springfox.documentation.spring.web.readers.operation.OperationTagsReader
 

P

parameter(ParameterContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 
ParameterDataTypeReader - Class in springfox.documentation.spring.web.readers.parameter
 
ParameterDataTypeReader(TypeNameExtractor, TypeResolver) - Constructor for class springfox.documentation.spring.web.readers.parameter.ParameterDataTypeReader
 
ParameterDefaultReader - Class in springfox.documentation.spring.web.readers.parameter
 
ParameterDefaultReader() - Constructor for class springfox.documentation.spring.web.readers.parameter.ParameterDefaultReader
 
ParameterMultiplesReader - Class in springfox.documentation.spring.web.readers.parameter
 
ParameterMultiplesReader() - Constructor for class springfox.documentation.spring.web.readers.parameter.ParameterMultiplesReader
 
ParameterNameReader - Class in springfox.documentation.spring.web.readers.parameter
 
ParameterNameReader() - Constructor for class springfox.documentation.spring.web.readers.parameter.ParameterNameReader
 
ParameterRequiredReader - Class in springfox.documentation.spring.web.readers.parameter
 
ParameterRequiredReader() - Constructor for class springfox.documentation.spring.web.readers.parameter.ParameterRequiredReader
 
ParameterTypeReader - Class in springfox.documentation.spring.web.readers.parameter
 
ParameterTypeReader() - Constructor for class springfox.documentation.spring.web.readers.parameter.ParameterTypeReader
 
pathMapping(String) - Method in class springfox.documentation.spring.web.plugins.Docket
Extensibility mechanism to add a servlet path mapping, if there is one, to the apis base path.
PathMappingAdjuster - Class in springfox.documentation.spring.web.paths
 
PathMappingAdjuster(DocumentationContext) - Constructor for class springfox.documentation.spring.web.paths.PathMappingAdjuster
 
pathProvider(PathProvider) - Method in class springfox.documentation.spring.web.plugins.Docket
Determines the generated, swagger specific, urls.
pathRoot(String) - Static method in class springfox.documentation.spring.web.ControllerNamingUtils
 
pathRootEncoded(String) - Static method in class springfox.documentation.spring.web.ControllerNamingUtils
 
Paths - Class in springfox.documentation.spring.web.paths
 
paths(Predicate<String>) - Method in class springfox.documentation.spring.web.plugins.ApiSelectorBuilder
 
pluginsManager - Variable in class springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterExpander
 
postProcessAfterInitialization(Object, String) - Method in class springfox.documentation.spring.web.ObjectMapperConfigurer
 
postProcessBeforeInitialization(Object, String) - Method in class springfox.documentation.spring.web.ObjectMapperConfigurer
 
produces(Set<String>) - Method in class springfox.documentation.spring.web.plugins.Docket
 
protocols(Set<String>) - Method in class springfox.documentation.spring.web.plugins.Docket
 

R

read(RequestMappingContext) - Method in class springfox.documentation.spring.web.readers.operation.ApiOperationReader
 
read(RequestMappingContext) - Method in interface springfox.documentation.spring.web.readers.operation.OperationReader
 
read(RequestMappingContext) - Method in class springfox.documentation.spring.web.scanners.ApiDescriptionReader
 
read(RequestMappingContext) - Method in class springfox.documentation.spring.web.scanners.ApiModelReader
 
read(RequestMappingContext) - Method in class springfox.documentation.spring.web.scanners.CachingOperationReader
 
readParameters(OperationContext) - Method in class springfox.documentation.spring.web.readers.operation.OperationParameterReader
 
RelativePathProvider - Class in springfox.documentation.spring.web.paths
 
RelativePathProvider(ServletContext) - Constructor for class springfox.documentation.spring.web.paths.RelativePathProvider
 
removeAdjacentForwardSlashes(String) - Static method in class springfox.documentation.spring.web.paths.Paths
 
requestHandlers() - Method in class springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider
 
resourceGroupCache() - Method in class springfox.documentation.spring.web.SpringfoxWebMvcConfiguration
 
resourceGroupingStrategy(DocumentationType) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 
ResponseMessagesReader - Class in springfox.documentation.spring.web.readers.operation
 
ResponseMessagesReader(TypeResolver, TypeNameExtractor) - Constructor for class springfox.documentation.spring.web.readers.operation.ResponseMessagesReader
 
ROOT - Static variable in class springfox.documentation.spring.web.paths.RelativePathProvider
 

S

sanitizeRequestMappingPattern(String) - Static method in class springfox.documentation.spring.web.paths.Paths
Gets a uri friendly path from a request mapping pattern.
scan(DocumentationContext) - Method in class springfox.documentation.spring.web.scanners.ApiDocumentationScanner
 
scan(DocumentationContext) - Method in class springfox.documentation.spring.web.scanners.ApiListingReferenceScanner
 
scan(ApiListingScanningContext) - Method in class springfox.documentation.spring.web.scanners.ApiListingScanner
 
securityContexts(List<SecurityContext>) - Method in class springfox.documentation.spring.web.plugins.Docket
Configures which api operations (via regex patterns) and HTTP methods to apply security contexts to apis.
securitySchemes(List<? extends SecurityScheme>) - Method in class springfox.documentation.spring.web.plugins.Docket
Configures the global com.wordnik.swagger.model.SecurityScheme's applicable to all or some of the api operations.
select() - Method in class springfox.documentation.spring.web.plugins.Docket
Initiates a builder for api selection.
setApplicationEventPublisher(ApplicationEventPublisher) - Method in class springfox.documentation.spring.web.ObjectMapperConfigurer
 
splitCamelCase(String, String) - Static method in class springfox.documentation.spring.web.paths.Paths
 
SPRING4_DISCOVERER - Static variable in class springfox.documentation.spring.web.readers.parameter.ParameterNameReader
 
springfox.documentation.spring.web - package springfox.documentation.spring.web
 
springfox.documentation.spring.web.json - package springfox.documentation.spring.web.json
 
springfox.documentation.spring.web.paths - package springfox.documentation.spring.web.paths
 
springfox.documentation.spring.web.plugins - package springfox.documentation.spring.web.plugins
 
springfox.documentation.spring.web.readers.operation - package springfox.documentation.spring.web.readers.operation
 
springfox.documentation.spring.web.readers.parameter - package springfox.documentation.spring.web.readers.parameter
 
springfox.documentation.spring.web.scanners - package springfox.documentation.spring.web.scanners
 
SpringfoxWebMvcConfiguration - Class in springfox.documentation.spring.web
 
SpringfoxWebMvcConfiguration() - Constructor for class springfox.documentation.spring.web.SpringfoxWebMvcConfiguration
 
SpringGroupingStrategy - Class in springfox.documentation.spring.web
TODO - fix or remove There are a lot of cases this strategy does not cover.
SpringGroupingStrategy() - Constructor for class springfox.documentation.spring.web.SpringGroupingStrategy
 
start() - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
 
startingWith(String) - Method in class springfox.documentation.spring.web.readers.operation.CachingOperationNameGenerator
 
stop(Runnable) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
 
stop() - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
 
stripSlashes(String) - Static method in class springfox.documentation.spring.web.paths.Paths
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.plugins.DefaultConfiguration
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.plugins.Docket
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.readers.operation.AbstractOperationParameterRequestConditionReader
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.readers.operation.DefaultOperationReader
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.readers.operation.OperationDeprecatedReader
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.readers.operation.OperationModelsProvider
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.readers.operation.OperationParameterReader
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.readers.operation.OperationResponseClassReader
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.readers.operation.OperationTagsReader
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.readers.operation.ResponseMessagesReader
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.readers.parameter.ExpandedParameterBuilder
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.readers.parameter.ParameterDataTypeReader
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.readers.parameter.ParameterDefaultReader
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.readers.parameter.ParameterMultiplesReader
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.readers.parameter.ParameterNameReader
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.readers.parameter.ParameterRequiredReader
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.readers.parameter.ParameterTypeReader
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.scanners.ApiListingReader
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.scanners.MediaTypeReader
 
supports(DocumentationType) - Method in class springfox.documentation.spring.web.SpringGroupingStrategy
 

T

tags(Tag, Tag...) - Method in class springfox.documentation.spring.web.plugins.Docket
Method to add global tags to the docket
tags(OperationContext) - Method in class springfox.documentation.spring.web.readers.operation.DefaultTagsProvider
 
toJson(Object) - Method in class springfox.documentation.spring.web.json.JsonSerializer
 

U

useDefaultResponseMessages(boolean) - Method in class springfox.documentation.spring.web.plugins.Docket
Allows ignoring predefined response message defaults
useType(Class) - Static method in class springfox.documentation.spring.web.readers.operation.HandlerMethodResolver
 

V

value() - Method in class springfox.documentation.spring.web.json.Json
 

W

WebMvcRequestHandlerProvider - Class in springfox.documentation.spring.web.plugins
 
WebMvcRequestHandlerProvider(List<RequestMappingInfoHandlerMapping>) - Constructor for class springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider
 
A B C D E F G H I J M O P R S T U V W