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

A

AbstractDocumentationPluginsBootstrapper - Class in springfox.documentation.spring.web.plugins

AbstractDocumentationPluginsBootstrapper(DocumentationPluginsManager, List<RequestHandlerProvider>, DocumentationCache, ApiDocumentationScanner, Defaults, TypeResolver, PathProvider) - Constructor for class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper

AbstractOperationParameterRequestConditionReader - Class in springfox.documentation.spring.web.readers.operation

AbstractOperationParameterRequestConditionReader(TypeResolver) - Constructor for class springfox.documentation.spring.web.readers.operation.AbstractOperationParameterRequestConditionReader

add(RequestHandlerKey, ApiDescription) - Method in class springfox.documentation.spring.web.scanners.ApiDescriptionLookup

add(ModelSpecification) - Method in class springfox.documentation.spring.web.scanners.ModelSpecificationRegistryBuilder

addAll(Collection<ModelSpecification>) - Method in class springfox.documentation.spring.web.scanners.ModelSpecificationRegistryBuilder

addDocumentation(Documentation) - Method in class springfox.documentation.spring.web.DocumentationCache

additionalListings(ApiListingScanningContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager

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

aggregate(Collection<RequestParameter>) - Method in class springfox.documentation.spring.web.readers.operation.ContentParameterAggregator

aggregate(Collection<RequestParameter>) - Method in interface springfox.documentation.spring.web.readers.operation.ParameterAggregator

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)

annotatedElements() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeField

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() - Method in class springfox.documentation.spring.web.scanners.ApiListingScanningContext

apiDescriptionOrdering(Comparator<ApiDescription>) - Method in class springfox.documentation.spring.web.plugins.Docket

Controls how io.swagger.model.ApiDescription's are ordered.

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(Comparator<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, ApiModelSpecificationReader, 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

Deprecated.

ApiModelReader(ModelProvider, TypeResolver, DocumentationPluginsManager, EnumTypeDeterminer, TypeNameExtractor) - Constructor for class springfox.documentation.spring.web.scanners.ApiModelReader

Deprecated.

ApiModelSpecificationReader - Class in springfox.documentation.spring.web.scanners

ApiModelSpecificationReader(ModelSpecificationProvider, DocumentationPluginsManager, TypeResolver) - Constructor for class springfox.documentation.spring.web.scanners.ApiModelSpecificationReader

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

apply(ApiListingContext) - Method in class springfox.documentation.spring.web.scanners.ApiListingReader

apply(ApiListingContext) - Method in class springfox.documentation.spring.web.scanners.MediaTypeReader

apply(DocumentationContextBuilder) - Method in class springfox.documentation.spring.web.plugins.DefaultConfiguration

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(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(OperationContext) - Method in class springfox.documentation.spring.web.scanners.MediaTypeReader

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(ParameterExpansionContext) - Method in class springfox.documentation.spring.web.readers.parameter.ExpandedParameterBuilder

apply(RequestMappingContext) - Method in class springfox.documentation.spring.web.readers.operation.OperationModelsProvider

apply(ResponseContext) - Method in class springfox.documentation.spring.web.plugins.DefaultResponseTypeReader

applyDefaults(DocumentationType, DocumentationContextBuilder) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager

B

bootstrapDocumentationPlugins() - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper

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

build() - Method in class springfox.documentation.spring.web.scanners.ModelSpecificationRegistryBuilder

buildContext(DocumentationPlugin) - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper

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

childContext(String, ResolvedType, OperationContext) - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext

clear() - Method in class springfox.documentation.spring.web.DocumentationCache

combine(RequestHandler) - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

CombinedRequestHandler - Class in springfox.documentation.spring.web.plugins

CombinedRequestHandler(RequestHandler, RequestHandler) - Constructor for class springfox.documentation.spring.web.plugins.CombinedRequestHandler

ComparisonCondition - Class in springfox.documentation.spring.web.scanners

ComparisonCondition(String, Set<String>, Set<String>) - Constructor for class springfox.documentation.spring.web.scanners.ComparisonCondition

configure(DocumentationContextBuilder) - Method in class springfox.documentation.spring.web.plugins.Docket

Builds the Docket by merging/overlaying user specified values.

consumes() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

consumes(Set<String>) - Method in class springfox.documentation.spring.web.plugins.Docket

containsModel(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext

ContentParameterAggregator - Class in springfox.documentation.spring.web.readers.operation

ContentParameterAggregator() - Constructor for class springfox.documentation.spring.web.readers.operation.ContentParameterAggregator

contextPath(String) - Static method in class springfox.documentation.spring.web.paths.Paths

controllerNameAsGroup(HandlerMethod) - Static method in class springfox.documentation.spring.web.ControllerNamingUtils

ControllerNamingUtils - Class in springfox.documentation.spring.web

create(DocumentationType) - Method in class springfox.documentation.spring.web.plugins.DefaultConfiguration

D

declaringClass() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

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, PathProvider) - Constructor for class springfox.documentation.spring.web.plugins.DefaultConfiguration

DefaultModelNamesRegistryFactory - Class in springfox.documentation.spring.web.scanners

DefaultModelNamesRegistryFactory() - Constructor for class springfox.documentation.spring.web.scanners.DefaultModelNamesRegistryFactory

DefaultOperationReader - Class in springfox.documentation.spring.web.readers.operation

DefaultOperationReader() - Constructor for class springfox.documentation.spring.web.readers.operation.DefaultOperationReader

DefaultPathProvider - Class in springfox.documentation.spring.web.paths

DefaultPathProvider() - Constructor for class springfox.documentation.spring.web.paths.DefaultPathProvider

DefaultResponseTypeReader - Class in springfox.documentation.spring.web.plugins

DefaultResponseTypeReader() - Constructor for class springfox.documentation.spring.web.plugins.DefaultResponseTypeReader

defaults() - Method in class springfox.documentation.spring.web.SpringfoxWebConfiguration

description(RequestHandler) - Method in class springfox.documentation.spring.web.scanners.ApiDescriptionLookup

descriptionResolver(Environment) - Method in class springfox.documentation.spring.web.SpringfoxWebConfiguration

DescriptionResolver - Class in springfox.documentation.spring.web

DescriptionResolver(Environment) - Constructor for class springfox.documentation.spring.web.DescriptionResolver

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 Springfox 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

Builds and executes all DocumentationConfigurer instances found in the application context, at the end of all phases in SmartLifecycle .

DocumentationPluginsBootstrapper(DocumentationPluginsManager, List<RequestHandlerProvider>, DocumentationCache, ApiDocumentationScanner, TypeResolver, Defaults, PathProvider, Environment) - 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

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

equals(Object) - Method in class springfox.documentation.spring.web.OperationCachingEquivalence.Wrapper

equals(Object) - Method in class springfox.documentation.spring.web.scanners.ComparisonCondition

expand(ExpansionContext) - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterExpander

ExpandedParameterBuilder - Class in springfox.documentation.spring.web.readers.parameter

ExpandedParameterBuilder(TypeResolver, EnumTypeDeterminer) - Constructor for class springfox.documentation.spring.web.readers.parameter.ExpandedParameterBuilder

expandParameter(ParameterExpansionContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager

ExpansionContext - Class in springfox.documentation.spring.web.readers.parameter

ExpansionContext(String, ResolvedType, OperationContext) - Constructor for class springfox.documentation.spring.web.readers.parameter.ExpansionContext

extensions(List<VendorExtension>) - Method in class springfox.documentation.spring.web.plugins.Docket

Add to the api's vendor extensions

F

findAnnotation(Class<A>) - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterMetadataAccessor

findAnnotation(Class<T>) - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

findControllerAnnotation(Class<T>) - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

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.

get() - Method in class springfox.documentation.spring.web.OperationCachingEquivalence.Wrapper

getAlternateTypeProvider() - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext

getCircleParameters(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext

getCircles() - Method in class springfox.documentation.spring.web.scanners.MergingContext

getCombiner() - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper

getComparisonCondition(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext

getConditions() - Method in class springfox.documentation.spring.web.scanners.ComparisonCondition

getDefaultConfiguration() - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper

getDocumentationContext() - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext

getDocumentationContext() - Method in class springfox.documentation.spring.web.scanners.ApiListingScanningContext

getDocumentationPath() - Method in class springfox.documentation.spring.web.paths.DefaultPathProvider

The base path to the swagger api documentation.

getDocumentationPluginsManager() - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper

getDocumentationType() - Method in class springfox.documentation.spring.web.plugins.Docket

getDocumentationType() - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext

getDocumentationType() - Method in class springfox.documentation.spring.web.scanners.ApiListingScanningContext

getFieldName() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterMetadataAccessor

getFieldType() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeField

getFieldType() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterMetadataAccessor

getGroupName() - Method in class springfox.documentation.spring.web.plugins.Docket

getHandlerMethod() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

getHandlerProviders() - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper

getModel(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext

getModelContext(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext

getModelFor() - Method in class springfox.documentation.spring.web.scanners.ComparisonCondition

getModelParameter(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext

getModelsTo() - Method in class springfox.documentation.spring.web.scanners.ComparisonCondition

getName() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

getName() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeField

getOperationContext() - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext

getOperationPath(String) - Method in class springfox.documentation.spring.web.paths.DefaultPathProvider

The relative path to the operation, from the basePath, which this operation describes.

getOrder() - Method in class springfox.documentation.spring.web.plugins.JacksonSerializerConvention

getParameterId() - Method in class springfox.documentation.spring.web.scanners.MergingContext

getParameters() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

getParameters(Set<NameValueExpression<String>>, String) - Method in class springfox.documentation.spring.web.readers.operation.AbstractOperationParameterRequestConditionReader

getParamType() - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext

getParentName() - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext

getPatternsCondition() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

getPhase() - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper

getPluginsManager() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterExpander

getRequestMapping() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

getRequestMappingsByResourceGroup() - Method in class springfox.documentation.spring.web.scanners.ApiListingScanningContext

getRequestParameters(Set<NameValueExpression<String>>, ParameterType) - Method in class springfox.documentation.spring.web.readers.operation.AbstractOperationParameterRequestConditionReader

getResolvedMembers() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeField

getResourceGroupRequestMappings() - Method in class springfox.documentation.spring.web.scanners.ApiListingReferenceScanResult

getResourceListing() - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper

getResourceListingPath(String, String) - Method in class springfox.documentation.spring.web.paths.DefaultPathProvider

Corresponds to the path attribute of a swagger Resource Object (within a Resource Listing).

getReturnType() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

getRootId() - Method in class springfox.documentation.spring.web.scanners.MergingContext

getRootModel() - Method in class springfox.documentation.spring.web.scanners.MergingContext

getScanned() - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper

getSimilarTypeModels(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext

getTypeConventions() - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper

globalOperationParameters(List<Parameter>) - Method in class springfox.documentation.spring.web.plugins.Docket

Deprecated.

globalRequestParameters(List<RequestParameter>) - 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

Deprecated.

globalResponses(HttpMethod, List<Response>) - Method in class springfox.documentation.spring.web.plugins.Docket

Overrides the default http response messages at the http request method level.

groupName() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

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

hashCode() - Method in class springfox.documentation.spring.web.OperationCachingEquivalence.Wrapper

hashCode() - Method in class springfox.documentation.spring.web.scanners.ComparisonCondition

hasSeenBefore(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext

hasSeenType(ResolvedType) - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext

headers() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

host(String) - Method in class springfox.documentation.spring.web.plugins.Docket

httpStatusCode(OperationContext) - Static method in class springfox.documentation.spring.web.readers.operation.ResponseMessagesReader

I

ignorableTypes() - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext

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.

isAnnotatedWith(Class<? extends Annotation>) - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

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

JacksonSerializerConvention - Class in springfox.documentation.spring.web.plugins

Class to automatically detect type substitutions given the jackson serialize/deserialize annotations

JacksonSerializerConvention(TypeResolver, String) - Constructor for class springfox.documentation.spring.web.plugins.JacksonSerializerConvention

Json - Class in springfox.documentation.spring.web.json

Json(String) - Constructor for class springfox.documentation.spring.web.json.Json

jsonSerializer(List<JacksonModuleRegistrar>) - Method in class springfox.documentation.spring.web.SpringfoxWebConfiguration

JsonSerializer - Class in springfox.documentation.spring.web.json

JsonSerializer(List<JacksonModuleRegistrar>) - Constructor for class springfox.documentation.spring.web.json.JsonSerializer

K

key() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

M

matches(ConditionContext, AnnotatedTypeMetadata) - Method in class springfox.documentation.spring.web.plugins.SpringIntegrationPluginNotPresentInClassPathCondition

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() - Constructor for class springfox.documentation.spring.web.scanners.MediaTypeReader

MergingContext - Class in springfox.documentation.spring.web.scanners

MergingContext(String, Map<String, Set<Model>>, Map<String, String>, Map<String, Model>, Map<String, ModelContext>) - Constructor for class springfox.documentation.spring.web.scanners.MergingContext

message(OperationContext) - Static method in class springfox.documentation.spring.web.readers.operation.ResponseMessagesReader

methodParameters(HandlerMethod) - Method in class springfox.documentation.spring.web.readers.operation.HandlerMethodResolver

methodResolver(TypeResolver) - Method in class springfox.documentation.spring.web.SpringfoxWebConfiguration

methodReturnType(HandlerMethod) - Method in class springfox.documentation.spring.web.readers.operation.HandlerMethodResolver

ModelAttributeField - Class in springfox.documentation.spring.web.readers.parameter

ModelAttributeField(ResolvedType, String, ResolvedMember<?>, ResolvedMember<?>) - Constructor for class springfox.documentation.spring.web.readers.parameter.ModelAttributeField

ModelAttributeParameterExpander - Class in springfox.documentation.spring.web.readers.parameter

ModelAttributeParameterExpander(FieldProvider, AccessorsProvider, EnumTypeDeterminer) - Constructor for class springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterExpander

ModelAttributeParameterMetadataAccessor - Class in springfox.documentation.spring.web.readers.parameter

ModelAttributeParameterMetadataAccessor(List<AnnotatedElement>, ResolvedType, String) - Constructor for class springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterMetadataAccessor

modelContexts(RequestMappingContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager

modelNamesGeneratorFactory(DocumentationType) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager

modelNamesRegistry(ModelSpecificationRegistry) - Method in class springfox.documentation.spring.web.scanners.DefaultModelNamesRegistryFactory

ModelSpecificationRegistryBuilder - Class in springfox.documentation.spring.web.scanners

ModelSpecificationRegistryBuilder() - Constructor for class springfox.documentation.spring.web.scanners.ModelSpecificationRegistryBuilder

O

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

OperationCachingEquivalence.Wrapper - Class in springfox.documentation.spring.web

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(SchemaPluginsManager) - Constructor for class springfox.documentation.spring.web.readers.operation.OperationModelsProvider

operationOrdering(Comparator<Operation>) - Method in class springfox.documentation.spring.web.plugins.Docket

Provide an ordering schema for operations

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(ModelAttributeParameterExpander, EnumTypeDeterminer, ParameterAggregator) - 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(SchemaPluginsManager, EnumTypeDeterminer, TypeNameExtractor) - Constructor for class springfox.documentation.spring.web.readers.operation.OperationResponseClassReader

OperationTagsReader - Class in springfox.documentation.spring.web.readers.operation

OperationTagsReader() - Constructor for class springfox.documentation.spring.web.readers.operation.OperationTagsReader

P

parameter(ParameterContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager

ParameterAggregator - Interface in springfox.documentation.spring.web.readers.operation

ParameterDataTypeReader - Class in springfox.documentation.spring.web.readers.parameter

ParameterDataTypeReader(SchemaPluginsManager, TypeNameExtractor, EnumTypeDeterminer, ModelSpecificationFactory) - Constructor for class springfox.documentation.spring.web.readers.parameter.ParameterDataTypeReader

ParameterDefaultReader - Class in springfox.documentation.spring.web.readers.parameter

ParameterDefaultReader(DescriptionResolver) - 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(DescriptionResolver) - 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

params() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

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() - Method in class springfox.documentation.spring.web.SpringfoxWebConfiguration

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(Predicate<String>) - Method in class springfox.documentation.spring.web.plugins.ApiSelectorBuilder

Paths - Class in springfox.documentation.spring.web.paths

produces() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

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

Deprecated.

read(RequestMappingContext) - Method in class springfox.documentation.spring.web.scanners.ApiModelSpecificationReader

read(RequestMappingContext) - Method in class springfox.documentation.spring.web.scanners.CachingOperationReader

removeAdjacentForwardSlashes(String) - Static method in class springfox.documentation.spring.web.paths.Paths

resolve(String) - Method in class springfox.documentation.spring.web.DescriptionResolver

resourceGroupCache() - Method in class springfox.documentation.spring.web.SpringfoxWebConfiguration

response(ResponseContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager

ResponseMessagesReader - Class in springfox.documentation.spring.web.readers.operation

ResponseMessagesReader(EnumTypeDeterminer, TypeNameExtractor, SchemaPluginsManager, ModelSpecificationFactory, DocumentationPluginsManager) - Constructor for class springfox.documentation.spring.web.readers.operation.ResponseMessagesReader

ROOT - Static variable in class springfox.documentation.spring.web.paths.Paths

rootPathWhenEmpty(String) - Static method in class springfox.documentation.spring.web.paths.Paths

rules() - Method in class springfox.documentation.spring.web.plugins.JacksonSerializerConvention

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

scanDocumentation(DocumentationContext) - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper

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<SecurityScheme>) - Method in class springfox.documentation.spring.web.plugins.Docket

Configures the global io.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.

servers(Server, Server...) - Method in class springfox.documentation.spring.web.plugins.Docket

Method to add global tags to the docket

setCombiner(RequestHandlerCombiner) - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper

setCombiner(RequestHandlerCombiner) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper

setTypeConventions(List<AlternateTypeRuleConvention>) - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper

setTypeConventions(List<AlternateTypeRuleConvention>) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper

splitCamelCase(String, String) - Static method in class springfox.documentation.spring.web.paths.Paths

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

SpringfoxWebConfiguration - Class in springfox.documentation.spring.web

SpringfoxWebConfiguration() - Constructor for class springfox.documentation.spring.web.SpringfoxWebConfiguration

SpringIntegrationPluginNotPresentInClassPathCondition - Class in springfox.documentation.spring.web.plugins

SpringIntegrationPluginNotPresentInClassPathCondition() - Constructor for class springfox.documentation.spring.web.plugins.SpringIntegrationPluginNotPresentInClassPathCondition

start() - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper

startingWith(String) - Method in class springfox.documentation.spring.web.readers.operation.CachingOperationNameGenerator

stop() - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper

stop(Runnable) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper

stripSlashes(String) - Static method in class springfox.documentation.spring.web.paths.Paths

supportedMethods() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

supports(DocumentationType) - Method in class springfox.documentation.spring.web.plugins.DefaultConfiguration

supports(DocumentationType) - Method in class springfox.documentation.spring.web.plugins.DefaultResponseTypeReader

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.DefaultModelNamesRegistryFactory

supports(DocumentationType) - Method in class springfox.documentation.spring.web.scanners.MediaTypeReader

T

tags(Tag, Tag...) - Method in class springfox.documentation.spring.web.plugins.Docket

Method to add global tags to the docket

test(RequestMappingContext, RequestMappingContext) - Method in class springfox.documentation.spring.web.OperationCachingEquivalence

toJson(Object) - Method in class springfox.documentation.spring.web.json.JsonSerializer

toRootId(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext

toRootId(String, Set<ComparisonCondition>, Set<String>) - Method in class springfox.documentation.spring.web.scanners.MergingContext

toString() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler

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

wrap(RequestMappingContext) - Method in class springfox.documentation.spring.web.OperationCachingEquivalence

Wrapper(RequestMappingContext, OperationCachingEquivalence) - Constructor for class springfox.documentation.spring.web.OperationCachingEquivalence.Wrapper

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