Skip navigation links
A B C D E F G H I K L M N O P R S T V W 

A

addInputParam(Type) - Method in class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder
 
additionalIgnorableTypes(Set<Class>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
additionalModels(Set<ResolvedType>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
additionalOperationParameters(List<Parameter>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
additionalResponseMessages(Map<RequestMethod, List<ResponseMessage>>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
addReturn(Type) - Method in class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder
 
addRule(AlternateTypeRule) - Method in class springfox.documentation.spi.schema.AlternateTypeProvider
 
adjustedPath(String) - Method in interface springfox.documentation.service.PathAdjuster
 
alternateFor(ResolvedType) - Method in class springfox.documentation.spi.schema.AlternateTypeProvider
 
alternateFor(ResolvedType) - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
alternateFor(ResolvedType) - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
alternateFor(ResolvedType) - Method in class springfox.documentation.spi.service.contexts.ParameterContext
 
alternateFor(ResolvedType) - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
AlternateTypeProvider - Class in springfox.documentation.spi.schema
 
AlternateTypeProvider(List<AlternateTypeRule>) - Constructor for class springfox.documentation.spi.schema.AlternateTypeProvider
 
apiDescriptionBuilder() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
apiDescriptionOrdering() - Method in class springfox.documentation.spi.service.contexts.Defaults
 
apiDescriptionOrdering(Ordering<ApiDescription>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
apiInfo(ApiInfo) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
apiListingBuilder() - Method in class springfox.documentation.spi.service.contexts.ApiListingContext
 
ApiListingBuilderPlugin - Interface in springfox.documentation.spi.service
 
ApiListingContext - Class in springfox.documentation.spi.service.contexts
 
ApiListingContext(DocumentationType, ResourceGroup, ApiListingBuilder) - Constructor for class springfox.documentation.spi.service.contexts.ApiListingContext
 
apiListingReferenceOrdering() - Method in class springfox.documentation.spi.service.contexts.Defaults
 
apiListingReferenceOrdering(Ordering<ApiListingReference>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
ApiListingScannerPlugin - Interface in springfox.documentation.spi.service
 
apiPathCompatator() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
ApiSelector - Class in springfox.documentation.spi.service.contexts
 
ApiSelector(Predicate<RequestHandler>, Predicate<String>) - Constructor for class springfox.documentation.spi.service.contexts.ApiSelector
 
apply(ModelContext) - Method in interface springfox.documentation.spi.schema.ModelBuilderPlugin
Implement this method to override the @see springfox.documentation.schema.Model using the @see springfox .documentation.builders.ModelBuilder
apply(ModelPropertyContext) - Method in interface springfox.documentation.spi.schema.ModelPropertyBuilderPlugin
Implement this method to override the @see springfox.documentation.schema.ModelProperty using the @see springfox .documentation.builders.ModelPropertyBuilder
apply(ApiListingContext) - Method in interface springfox.documentation.spi.service.ApiListingBuilderPlugin
Implement this method to override the ApiListing using the ApiListingBuilder
apply(DocumentationContext) - Method in interface springfox.documentation.spi.service.ApiListingScannerPlugin
Implement this method to manually add ApiDescriptions
apply(ParameterExpansionContext) - Method in interface springfox.documentation.spi.service.ExpandedParameterBuilderPlugin
Implement this method to override the Parameter using ParameterBuilder available in the context
apply(OperationContext) - Method in interface springfox.documentation.spi.service.OperationBuilderPlugin
Implement this method to override the Operation using the OperationBuilder available in the context
apply(RequestMappingContext) - Method in interface springfox.documentation.spi.service.OperationModelsProviderPlugin
Implement this method to collect input parameters and return values
apply(ParameterContext) - Method in interface springfox.documentation.spi.service.ParameterBuilderPlugin
Implement this method to collect input parameters and return values
applyDefaultResponseMessages(boolean) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 

B

build() - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
build() - Method in class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder
 
build() - Method in class springfox.documentation.spi.service.contexts.SecurityContextBuilder
 
builder() - Static method in class springfox.documentation.spi.service.contexts.SecurityContext
 
byOperationName() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
byPatternsCondition() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
byPluginName() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
byPluginType() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 

C

canIgnore(ResolvedType) - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
combine(List<RequestHandler>) - Method in interface springfox.documentation.spi.service.RequestHandlerCombiner
 
configure(DocumentationContextBuilder) - Method in interface springfox.documentation.spi.service.DocumentationPlugin
Creates a documentation context based on a given DocumentationContextBuilder
consumes(Set<String>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
consumes() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
consumes() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
copyPatternUsing(String) - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
create(ModelContext) - Method in interface springfox.documentation.spi.schema.SyntheticModelProviderPlugin
Creates a synthetic model
create(DocumentationType) - Method in interface springfox.documentation.spi.service.DefaultsProviderPlugin
Implement this method to override the @see springfox.documentation.spi.service.contexts .DocumentationContextBuilder

D

decorator(PathContext) - Method in interface springfox.documentation.service.PathDecorator
 
DEFAULT - Static variable in class springfox.documentation.spi.service.contexts.ApiSelector
 
defaultExcludeAnnotations() - Method in class springfox.documentation.spi.service.contexts.Defaults
 
defaultIgnorableParameterTypes() - Method in class springfox.documentation.spi.service.contexts.Defaults
 
defaultResponseMessages() - Method in class springfox.documentation.spi.service.contexts.Defaults
Default response messages set on all api operations
defaultResponseMessages(Map<RequestMethod, List<ResponseMessage>>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
defaultRules(TypeResolver) - Method in class springfox.documentation.spi.service.contexts.Defaults
 
Defaults - Class in springfox.documentation.spi.service.contexts
 
Defaults() - Constructor for class springfox.documentation.spi.service.contexts.Defaults
 
DefaultsProviderPlugin - Interface in springfox.documentation.spi.service
 
dependencies(ModelContext) - Method in interface springfox.documentation.spi.schema.SyntheticModelProviderPlugin
Creates a dependencies for the synthetic model
description() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
DocumentationContext - Class in springfox.documentation.spi.service.contexts
 
DocumentationContext(DocumentationType, List<RequestHandler>, ApiInfo, String, ApiSelector, Set<Class>, Map<RequestMethod, List<ResponseMessage>>, List<Parameter>, ResourceGroupingStrategy, PathProvider, List<SecurityContext>, List<? extends SecurityScheme>, List<AlternateTypeRule>, Ordering<ApiListingReference>, Ordering<ApiDescription>, Ordering<Operation>, Set<String>, Set<String>, String, Set<String>, GenericTypeNamingStrategy, Optional<String>, boolean, Set<ResolvedType>, Set<Tag>, List<VendorExtension>) - Constructor for class springfox.documentation.spi.service.contexts.DocumentationContext
 
documentationContext() - Method in class springfox.documentation.spi.service.contexts.PathContext
 
DocumentationContextBuilder - Class in springfox.documentation.spi.service.contexts
 
DocumentationContextBuilder(DocumentationType) - Constructor for class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
DocumentationPlugin - Interface in springfox.documentation.spi.service
 
DocumentationType - Class in springfox.documentation.spi
 
DocumentationType(String, String, MediaType) - Constructor for class springfox.documentation.spi.DocumentationType
Creates a new instance of SimplePluginMetadata.
DocumentationType(String, String) - Constructor for class springfox.documentation.spi.DocumentationType
 

E

enableUrlTemplating(boolean) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
EnumTypeDeterminer - Interface in springfox.documentation.spi.schema
 
equals(Object) - Method in class springfox.documentation.spi.DocumentationType
 
equals(Object) - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
ExpandedParameterBuilderPlugin - Interface in springfox.documentation.spi.service
 

F

findAllAnnotations(Class<T>) - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
findAnnotation(Class<T>) - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
findAnnotation(Class<A>) - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
 
findAnnotation(Class<T>) - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
findAnnotation(Class<T>) - Method in interface springfox.documentation.spi.service.ParameterMetadataAccessor
 
findAnnotations(Class<T>) - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
findControllerAnnotation(Class<T>) - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
findControllerAnnotation(Class<T>) - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
forHttpMethods(Predicate<HttpMethod>) - Method in class springfox.documentation.spi.service.contexts.SecurityContextBuilder
 
forPaths(Predicate<String>) - Method in class springfox.documentation.spi.service.contexts.SecurityContextBuilder
 
fromParent(ModelContext, ResolvedType) - Static method in class springfox.documentation.spi.schema.contexts.ModelContext
Convenience method to provide an new context for an input parameter

G

genericsNaming(GenericTypeNamingStrategy) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
GenericTypeNamingStrategy - Interface in springfox.documentation.spi.schema
Strategy to provide the strings used while naming generic types in the swagger output
getAdditionalModels() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getAdditionalModels() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getAlternateTypeProvider() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
getAlternateTypeProvider() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getAlternateTypeProvider() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
getAlternateTypeProvider() - Method in class springfox.documentation.spi.service.contexts.ParameterContext
 
getAnnotatedElement() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext
 
getApiDescriptionOrdering() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getApiInfo() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getApiSelector() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getBeanPropertyDefinition() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext
 
getBuilder() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
getBuilder() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext
Model property build.
getCloseGeneric() - Method in interface springfox.documentation.spi.schema.GenericTypeNamingStrategy
 
getConsumes() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getDataTypeName() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
 
getDocumentationContext() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
getDocumentationContext() - Method in class springfox.documentation.spi.service.contexts.ParameterContext
 
getDocumentationContext() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getDocumentationType() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
getDocumentationType() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext
Documentation type this context supports, swagger 1.2, 2.0 or vanilla spring mvc
getDocumentationType() - Method in class springfox.documentation.spi.service.contexts.ApiListingContext
 
getDocumentationType() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getDocumentationType() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
getDocumentationType() - Method in class springfox.documentation.spi.service.contexts.ParameterContext
 
getDocumentationType() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
 
getDocumentationType() - Method in interface springfox.documentation.spi.service.DocumentationPlugin
 
getField() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
Deprecated.
@since 2.8.0
getFieldName() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
 
getFieldName() - Method in interface springfox.documentation.spi.service.ParameterMetadataAccessor
 
getFieldType() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
 
getFieldType() - Method in interface springfox.documentation.spi.service.ParameterMetadataAccessor
 
getGenericNamingStrategy() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
getGenericNamingStrategy() - Method in class springfox.documentation.spi.service.contexts.ParameterContext
 
getGenericsNamingStrategy() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getGenericsNamingStrategy() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
getGenericsNamingStrategy() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getGlobalOperationParameters() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
getGlobalRequestParameters() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getGlobalResponseMessages() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getGlobalResponseMessages(String) - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
getGroupName() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
getGroupName() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getGroupName() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
getGroupName() - Method in class springfox.documentation.spi.service.contexts.ParameterContext
 
getGroupName() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getGroupName() - Method in interface springfox.documentation.spi.service.DocumentationPlugin
Gets the group name for the plugin.
getHost() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getIgnorableParameterTypes() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getIgnorableParameterTypes() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
getIgnorableParameterTypes() - Method in class springfox.documentation.spi.service.contexts.ParameterContext
 
getIgnorableParameterTypes() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getListingReferenceOrdering() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getMediaType() - Method in class springfox.documentation.spi.DocumentationType
 
getMethodsCondition() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getMethodSelector() - Method in class springfox.documentation.spi.service.contexts.SecurityContext
 
getModelMap() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getName() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
getName() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getOpenGeneric() - Method in interface springfox.documentation.spi.schema.GenericTypeNamingStrategy
 
getOperationContext() - Method in class springfox.documentation.spi.service.contexts.ParameterContext
 
getParameterBuilder() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
 
getParameters() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
getParameters() - Method in class springfox.documentation.spi.service.contexts.PathContext
 
getParameters() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getParameterType() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
 
getParentName() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
 
getPathMapping() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getPathProvider() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getPathSelector() - Method in class springfox.documentation.spi.service.contexts.ApiSelector
 
getPatternsCondition() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getProduces() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getProtocols() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getRequestHandlers() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getRequestHandlerSelector() - Method in class springfox.documentation.spi.service.contexts.ApiSelector
 
getRequestMappingPattern() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getResolver() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext
 
getResourceDescription(RequestMappingInfo, HandlerMethod) - Method in interface springfox.documentation.spi.service.ResourceGroupingStrategy
Deprecated.
@since 2.0.2
getResourceGroup() - Method in class springfox.documentation.spi.service.contexts.ApiListingContext
 
getResourceGroupingStrategy() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
Deprecated.
@since 2.2.0 - only here for backward compatibility
getResourceGroups(RequestMappingInfo, HandlerMethod) - Method in interface springfox.documentation.spi.service.ResourceGroupingStrategy
Deprecated.
Gets the resource group for a particular request mapping.
getResourcePosition(RequestMappingInfo, HandlerMethod) - Method in interface springfox.documentation.spi.service.ResourceGroupingStrategy
Deprecated.
@since 2.0.2
getReturnType() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
getReturnType() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getSecurityContexts() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getSecurityReferences() - Method in class springfox.documentation.spi.service.contexts.SecurityContext
 
getSecuritySchemes() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getTags() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getType() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
getTypeListDelimiter() - Method in interface springfox.documentation.spi.schema.GenericTypeNamingStrategy
 
getVendorExtentions() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
groupName(String) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 

H

hashCode() - Method in class springfox.documentation.spi.DocumentationType
 
hashCode() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
hasSeenBefore(ResolvedType) - Method in class springfox.documentation.spi.schema.contexts.ModelContext
Answers the question, has the given type been processed?
headers() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
headers() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
host(String) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
httpMethod() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 

I

inputParam(String, Type, DocumentationType, AlternateTypeProvider, GenericTypeNamingStrategy, ImmutableSet<Class>) - Static method in class springfox.documentation.spi.schema.contexts.ModelContext
Convenience method to provide an new context for an input parameter
isEnabled() - Method in interface springfox.documentation.spi.service.DocumentationPlugin
 
isEnum(Class<?>) - Method in interface springfox.documentation.spi.schema.EnumTypeDeterminer
 
isReturnType() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
isUriTemplatesEnabled() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 

K

key() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 

L

listingPositionComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
listingReferencePathComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 

M

methodComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
methodParameter() - Method in class springfox.documentation.spi.service.contexts.ParameterContext
ModelBuilderPlugin - Interface in springfox.documentation.spi.schema
 
ModelContext - Class in springfox.documentation.spi.schema.contexts
 
ModelPropertyBuilderPlugin - Interface in springfox.documentation.spi.schema
 
ModelPropertyContext - Class in springfox.documentation.spi.schema.contexts
 
ModelPropertyContext(ModelPropertyBuilder, AnnotatedElement, TypeResolver, DocumentationType) - Constructor for class springfox.documentation.spi.schema.contexts.ModelPropertyContext
 
ModelPropertyContext(ModelPropertyBuilder, BeanPropertyDefinition, TypeResolver, DocumentationType) - Constructor for class springfox.documentation.spi.schema.contexts.ModelPropertyContext
 

N

nameFor(Class<?>) - Method in interface springfox.documentation.spi.schema.TypeNameProviderPlugin
Given a class name provides a name for it
nickNameComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 

O

operationBuilder() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
OperationBuilderPlugin - Interface in springfox.documentation.spi.service
 
OperationContext - Class in springfox.documentation.spi.service.contexts
 
OperationContext(OperationBuilder, RequestMethod, RequestMappingContext, int) - Constructor for class springfox.documentation.spi.service.contexts.OperationContext
 
operationIndex() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
OperationModelContextsBuilder - Class in springfox.documentation.spi.service.contexts
 
OperationModelContextsBuilder(String, DocumentationType, AlternateTypeProvider, GenericTypeNamingStrategy, ImmutableSet<Class>) - Constructor for class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder
 
operationModelsBuilder() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
OperationModelsProviderPlugin - Interface in springfox.documentation.spi.service
 
operationOrdering() - Method in class springfox.documentation.spi.service.contexts.Defaults
 
operationOrdering() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
operationOrdering(Ordering<Operation>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
operationOrdering() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
Orderings - Class in springfox.documentation.spi.service.contexts
 

P

parameterBuilder() - Method in class springfox.documentation.spi.service.contexts.ParameterContext
 
ParameterBuilderPlugin - Interface in springfox.documentation.spi.service
 
ParameterContext - Class in springfox.documentation.spi.service.contexts
 
ParameterContext(ResolvedMethodParameter, ParameterBuilder, DocumentationContext, GenericTypeNamingStrategy, OperationContext) - Constructor for class springfox.documentation.spi.service.contexts.ParameterContext
 
ParameterExpansionContext - Class in springfox.documentation.spi.service.contexts
 
ParameterExpansionContext(String, String, String, ParameterMetadataAccessor, DocumentationType, ParameterBuilder) - Constructor for class springfox.documentation.spi.service.contexts.ParameterExpansionContext
 
ParameterMetadataAccessor - Interface in springfox.documentation.spi.service
 
params() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
params() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
PathAdjuster - Interface in springfox.documentation.service
 
PathContext - Class in springfox.documentation.spi.service.contexts
 
PathContext(RequestMappingContext, Optional<Operation>) - Constructor for class springfox.documentation.spi.service.contexts.PathContext
 
PathDecorator - Interface in springfox.documentation.service
Path decorator is useful to create transformations from a given path based on the RequestMappingContext.
pathMapping(Optional<String>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
pathProvider(PathProvider) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
pathProvider() - Method in class springfox.documentation.spi.service.contexts.PathContext
 
patternsCondition(RequestHandler) - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
pluginOrdering() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
positionComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
produces(Set<String>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
produces() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
produces() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
properties(ModelContext) - Method in interface springfox.documentation.spi.schema.SyntheticModelProviderPlugin
Creates a synthetic model properties
protocols(Set<String>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 

R

RequestHandlerCombiner - Interface in springfox.documentation.spi.service
This is a class that knows how to combine a set of request handlers so that it doesnt drop "duplicates"
RequestHandlerProvider - Interface in springfox.documentation.spi.service
 
requestHandlers(List<RequestHandler>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
requestHandlers() - Method in interface springfox.documentation.spi.service.RequestHandlerProvider
 
RequestMappingContext - Class in springfox.documentation.spi.service.contexts
 
RequestMappingContext(DocumentationContext, RequestHandler) - Constructor for class springfox.documentation.spi.service.contexts.RequestMappingContext
 
requestMappingPattern() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
resolvedMethodParameter() - Method in class springfox.documentation.spi.service.contexts.ParameterContext
 
resolvedType(TypeResolver) - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
resourceGroupComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
ResourceGroupingStrategy - Interface in springfox.documentation.spi.service
Deprecated.
@since 2.2.0 - only here for backward compatibility
returnValue(String, Type, DocumentationType, AlternateTypeProvider, GenericTypeNamingStrategy, ImmutableSet<Class>) - Static method in class springfox.documentation.spi.schema.contexts.ModelContext
Convenience method to provide an new context for an return parameter
ruleBuilders(List<Function<TypeResolver, AlternateTypeRule>>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
rules(List<AlternateTypeRule>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 

S

securityContext() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
SecurityContext - Class in springfox.documentation.spi.service.contexts
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
SecurityContext(List<SecurityReference>, Predicate<String>) - Constructor for class springfox.documentation.spi.service.contexts.SecurityContext
 
SecurityContext(List<SecurityReference>, Predicate<String>, Predicate<HttpMethod>) - Constructor for class springfox.documentation.spi.service.contexts.SecurityContext
 
SecurityContextBuilder - Class in springfox.documentation.spi.service.contexts
 
securityContexts(List<SecurityContext>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
securityForOperation(OperationContext) - Method in class springfox.documentation.spi.service.contexts.SecurityContext
 
securityForPath(String) - Method in class springfox.documentation.spi.service.contexts.SecurityContext
securityReferences(List<SecurityReference>) - Method in class springfox.documentation.spi.service.contexts.SecurityContextBuilder
 
securitySchemes(List<? extends SecurityScheme>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
seen(ResolvedType) - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
selector(ApiSelector) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
SPRING_WEB - Static variable in class springfox.documentation.spi.DocumentationType
 
springfox.documentation.service - package springfox.documentation.service
 
springfox.documentation.spi - package springfox.documentation.spi
 
springfox.documentation.spi.schema - package springfox.documentation.spi.schema
 
springfox.documentation.spi.schema.contexts - package springfox.documentation.spi.schema.contexts
 
springfox.documentation.spi.service - package springfox.documentation.spi.service
 
springfox.documentation.spi.service.contexts - package springfox.documentation.spi.service.contexts
 
SWAGGER_12 - Static variable in class springfox.documentation.spi.DocumentationType
 
SWAGGER_2 - Static variable in class springfox.documentation.spi.DocumentationType
 
SyntheticModelProviderPlugin - Interface in springfox.documentation.spi.schema
Plugin to generate custom models

T

tags(Set<Tag>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
TypeNameProviderPlugin - Interface in springfox.documentation.spi.schema
 
typeResolver(TypeResolver) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 

V

vendorExtentions(List<VendorExtension>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 

W

withKnownModels(Map<String, Model>) - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
withResourceGroupingStrategy(ResourceGroupingStrategy) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
Deprecated.
@since 2.2.0 - only here for backward compatibility
A B C D E F G H I K L M N O P R S T V W 
Skip navigation links