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

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
 
Accessors - Class in springfox.documentation.schema.property.bean
 
AccessorsProvider - Class in springfox.documentation.schema.property.bean
 
AccessorsProvider(TypeResolver) - Constructor for class springfox.documentation.schema.property.bean.AccessorsProvider
 
add(RequestHandlerKey, ApiDescription) - Method in class springfox.documentation.spring.web.scanners.ApiDescriptionLookup
 
add(V) - Method in class springfox.petstore.repository.MapBackedRepository
 
add(V) - Method in class springfox.petstore.webflux.repository.MapBackedRepository
 
addDocumentation(Documentation) - Method in class springfox.documentation.spring.web.DocumentationCache
 
addInputParam(Type) - Method in class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder
 
additionalIgnorableTypes(Set<Class>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
additionalListings(ApiListingScanningContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 
additionalModels(Set<ResolvedType>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
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
additionalOperationParameters(List<Parameter>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
additionalQueryStringParams(Map<String, Object>) - Method in class springfox.documentation.swagger.web.SecurityConfigurationBuilder
 
additionalResponseMessages(Map<RequestMethod, List<ResponseMessage>>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
addPet(Pet) - Method in class springfox.petstore.controller.PetController
 
addPet(Pet) - Method in class springfox.petstore.webflux.controller.PetController
 
addProperty(VendorExtension) - Method in class springfox.documentation.service.ObjectVendorExtension
 
addReturn(Type) - Method in class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder
 
addRule(AlternateTypeRule) - Method in class springfox.documentation.spi.schema.AlternateTypeProvider
 
addValidVendorExtensions(List<VendorExtension>) - Method in class springfox.documentation.service.SecurityScheme
 
adjustedPath(String) - Method in interface springfox.documentation.service.PathAdjuster
 
adjustedPath(String) - Method in class springfox.documentation.spring.web.paths.PathMappingAdjuster
 
adjustedPath(String) - Method in class springfox.documentation.swagger.common.XForwardPrefixPathAdjuster
 
all() - Method in class springfox.documentation.spring.web.DocumentationCache
 
AllowableListValues - Class in springfox.documentation.service
 
AllowableListValues(List<String>, String) - Constructor for class springfox.documentation.service.AllowableListValues
 
AllowableListValues - Class in springfox.documentation.swagger1.dto
 
AllowableListValues() - Constructor for class springfox.documentation.swagger1.dto.AllowableListValues
 
AllowableListValues(List<String>, String) - Constructor for class springfox.documentation.swagger1.dto.AllowableListValues
 
allowableRange(Optional<Min>, Optional<Max>) - Static method in class springfox.bean.validators.plugins.RangeAnnotations
 
AllowableRangeValues - Class in springfox.documentation.service
 
AllowableRangeValues(String, String) - Constructor for class springfox.documentation.service.AllowableRangeValues
 
AllowableRangeValues(String, Boolean, String, Boolean) - Constructor for class springfox.documentation.service.AllowableRangeValues
 
AllowableRangeValues - Class in springfox.documentation.swagger1.dto
 
AllowableRangeValues() - Constructor for class springfox.documentation.swagger1.dto.AllowableRangeValues
 
AllowableRangeValues(String, String) - Constructor for class springfox.documentation.swagger1.dto.AllowableRangeValues
 
allowableValueFromString(String) - Static method in class springfox.documentation.swagger.schema.ApiModelProperties
 
allowableValues(AllowableValues) - Method in class springfox.documentation.builders.ModelPropertyBuilder
 
allowableValues(AllowableValues) - Method in class springfox.documentation.builders.ParameterBuilder
Updates if the parameter is bound by a range of values or a range of numerical values
allowableValues(Class<?>) - Static method in class springfox.documentation.schema.Enums
 
allowableValues() - Method in class springfox.documentation.schema.property.BaseModelProperty
 
allowableValues() - Method in interface springfox.documentation.schema.property.ModelProperty
 
allowableValues(ResolvedType) - Static method in class springfox.documentation.schema.ResolvedTypes
 
AllowableValues - Interface in springfox.documentation.service
 
AllowableValues - Interface in springfox.documentation.swagger1.dto
 
AllowableValuesMapper - Class in springfox.documentation.swagger1.mappers
 
AllowableValuesMapper() - Constructor for class springfox.documentation.swagger1.mappers.AllowableValuesMapper
 
allowEmptyValue(Boolean) - Method in class springfox.documentation.builders.ModelPropertyBuilder
Support for isAllowEmpty value
allowEmptyValue(Boolean) - Method in class springfox.documentation.builders.ParameterBuilder
Updates the flag that allows sending empty values for this parameter
allowMultiple(boolean) - Method in class springfox.documentation.builders.ParameterBuilder
Updates if the parameter should allow multiple values
alternate - Variable in class springfox.documentation.schema.AlternateTypeRule
 
alternateFor(ResolvedType) - Method in class springfox.documentation.schema.AlternateTypeRule
Provides alternate for supplier type.
alternateFor(ResolvedType) - Method in class springfox.documentation.schema.RecursiveAlternateTypeRule
 
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
 
AlternateTypeBuilder - Class in springfox.documentation.builders
 
AlternateTypeBuilder() - Constructor for class springfox.documentation.builders.AlternateTypeBuilder
 
AlternateTypePropertyBuilder - Class in springfox.documentation.builders
 
AlternateTypePropertyBuilder() - Constructor for class springfox.documentation.builders.AlternateTypePropertyBuilder
 
alternateTypeProvider - Variable in class springfox.documentation.schema.property.BaseModelProperty
 
AlternateTypeProvider - Class in springfox.documentation.spi.schema
 
AlternateTypeProvider(List<AlternateTypeRule>) - Constructor for class springfox.documentation.spi.schema.AlternateTypeProvider
 
AlternateTypeRule - Class in springfox.documentation.schema
 
AlternateTypeRule(ResolvedType, ResolvedType) - Constructor for class springfox.documentation.schema.AlternateTypeRule
Instantiates a new Alternate type rule.
AlternateTypeRule(ResolvedType, ResolvedType, int) - Constructor for class springfox.documentation.schema.AlternateTypeRule
Instantiates a new Alternate type rule.
AlternateTypeRuleConvention - Interface in springfox.documentation.schema
 
AlternateTypeRules - Class in springfox.documentation.schema
 
alternateTypeRules(AlternateTypeRule...) - Method in class springfox.documentation.spring.web.plugins.Docket
Adds model substitution rules (alternateTypeRules)
annotate(Annotation) - Method in class springfox.documentation.service.ResolvedMethodParameter
 
annotatedElements() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeField
 
annotationFromBean(ModelPropertyContext, Class<T>) - Static method in class springfox.bean.validators.plugins.Validators
 
annotationFromField(ModelPropertyContext, Class<T>) - Static method in class springfox.bean.validators.plugins.Validators
 
annotationFromParameter(ParameterContext, Class<T>) - Static method in class springfox.bean.validators.plugins.Validators
 
Annotations - Class in springfox.documentation.schema
 
Annotations - Class in springfox.documentation.swagger.annotations
 
ant(String) - Static method in class springfox.documentation.builders.PathSelectors
Predicate that evaluates the supplied ant pattern
any() - Static method in class springfox.documentation.builders.PathSelectors
Any path satisfies this condition
any() - Static method in class springfox.documentation.builders.RequestHandlerSelectors
Any RequestHandler satisfies this condition
ApiDescription - Class in springfox.documentation.service
 
ApiDescription(String, String, List<Operation>, Boolean) - Constructor for class springfox.documentation.service.ApiDescription
Deprecated.
@since 2.8.1
ApiDescription(String, String, String, List<Operation>, Boolean) - Constructor for class springfox.documentation.service.ApiDescription
 
ApiDescription - Class in springfox.documentation.swagger1.dto
 
ApiDescription() - Constructor for class springfox.documentation.swagger1.dto.ApiDescription
 
ApiDescription(String, String, List<Operation>, Boolean) - Constructor for class springfox.documentation.swagger1.dto.ApiDescription
 
ApiDescriptionBuilder - Class in springfox.documentation.builders
 
ApiDescriptionBuilder(Comparator<Operation>) - Constructor for class springfox.documentation.builders.ApiDescriptionBuilder
 
apiDescriptionBuilder() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
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.spi.service.contexts.Defaults
 
apiDescriptionOrdering(Comparator<ApiDescription>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
apiDescriptionOrdering(Comparator<ApiDescription>) - Method in class springfox.documentation.spring.web.plugins.Docket
Controls how io.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
 
ApiIgnore - Annotation Type in springfox.documentation.annotations
 
ApiInfo - Class in springfox.documentation.service
 
ApiInfo(String, String, String, String, String, String, String) - Constructor for class springfox.documentation.service.ApiInfo
Deprecated.
@since 2.4.0
ApiInfo(String, String, String, String, Contact, String, String, Collection<VendorExtension>) - Constructor for class springfox.documentation.service.ApiInfo
Default contstructor
apiInfo(ApiInfo) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
apiInfo(ApiInfo) - Method in class springfox.documentation.spring.web.plugins.Docket
Sets the api's meta information as included in the json ResourceListing response.
ApiInfo - Class in springfox.documentation.swagger1.dto
 
ApiInfo() - Constructor for class springfox.documentation.swagger1.dto.ApiInfo
 
ApiInfo(String, String, String, String, String, String) - Constructor for class springfox.documentation.swagger1.dto.ApiInfo
 
ApiInfoBuilder - Class in springfox.documentation.builders
Builds the api information
ApiInfoBuilder() - Constructor for class springfox.documentation.builders.ApiInfoBuilder
 
apiInfoToLicense(ApiInfo) - Method in class springfox.documentation.swagger2.mappers.LicenseMapper
 
ApiKey - Class in springfox.documentation.service
 
ApiKey(String, String, String) - Constructor for class springfox.documentation.service.ApiKey
 
ApiKey(String, String, String, List<VendorExtension>) - Constructor for class springfox.documentation.service.ApiKey
 
ApiKey - Class in springfox.documentation.swagger1.dto
 
ApiKey() - Constructor for class springfox.documentation.swagger1.dto.ApiKey
 
ApiKey(String, String) - Constructor for class springfox.documentation.swagger1.dto.ApiKey
 
ApiKey(String) - Constructor for class springfox.documentation.swagger1.dto.ApiKey
 
ApiKeyVehicle - Enum in springfox.documentation.swagger.web
 
ApiListing - Class in springfox.documentation.service
 
ApiListing(String, String, String, Set<String>, Set<String>, String, Set<String>, List<SecurityReference>, List<ApiDescription>, Map<String, Model>, String, int, Set<Tag>) - Constructor for class springfox.documentation.service.ApiListing
 
apiListing(ApiListingContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 
ApiListing - Class in springfox.documentation.swagger1.dto
 
ApiListing() - Constructor for class springfox.documentation.swagger1.dto.ApiListing
 
ApiListingBuilder - Class in springfox.documentation.builders
 
ApiListingBuilder(Comparator<ApiDescription>) - Constructor for class springfox.documentation.builders.ApiListingBuilder
Update the sorting order for api descriptions
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
 
ApiListingMerger - Class in springfox.documentation.swagger1.web
 
ApiListingMerger() - Constructor for class springfox.documentation.swagger1.web.ApiListingMerger
 
ApiListingReader - Class in springfox.documentation.spring.web.scanners
 
ApiListingReader() - Constructor for class springfox.documentation.spring.web.scanners.ApiListingReader
 
ApiListingReference - Class in springfox.documentation.service
 
ApiListingReference(String, String, int) - Constructor for class springfox.documentation.service.ApiListingReference
 
ApiListingReference - Class in springfox.documentation.swagger1.dto
 
ApiListingReference() - Constructor for class springfox.documentation.swagger1.dto.ApiListingReference
 
ApiListingReference(String, String, int) - Constructor for class springfox.documentation.swagger1.dto.ApiListingReference
 
apiListingReferenceOrdering() - Method in class springfox.documentation.spi.service.contexts.Defaults
 
apiListingReferenceOrdering(Comparator<ApiListingReference>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
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
 
apiListingsByResourceGroupName(Map<String, List<ApiListing>>) - Method in class springfox.documentation.builders.DocumentationBuilder
Updates the map with new entries
ApiListingScanner - Class in springfox.documentation.spring.web.scanners
 
ApiListingScanner(ApiDescriptionReader, ApiModelReader, DocumentationPluginsManager) - Constructor for class springfox.documentation.spring.web.scanners.ApiListingScanner
 
ApiListingScannerPlugin - Interface in springfox.documentation.spi.service
 
ApiListingScanningContext - Class in springfox.documentation.spring.web.scanners
 
ApiListingScanningContext(DocumentationContext, Map<ResourceGroup, List<RequestMappingContext>>) - Constructor for class springfox.documentation.spring.web.scanners.ApiListingScanningContext
 
ApiModelBuilder - Class in springfox.documentation.swagger.schema
 
ApiModelBuilder(TypeResolver, TypeNameExtractor) - Constructor for class springfox.documentation.swagger.schema.ApiModelBuilder
 
ApiModelProperties - Class in springfox.documentation.swagger.schema
 
ApiModelPropertyPropertyBuilder - Class in springfox.documentation.swagger.schema
 
ApiModelPropertyPropertyBuilder(DescriptionResolver) - Constructor for class springfox.documentation.swagger.schema.ApiModelPropertyPropertyBuilder
 
ApiModelReader - Class in springfox.documentation.spring.web.scanners
 
ApiModelReader(ModelProvider, TypeResolver, DocumentationPluginsManager) - Constructor for class springfox.documentation.spring.web.scanners.ApiModelReader
 
ApiModelTypeNameProvider - Class in springfox.documentation.swagger.schema
 
ApiModelTypeNameProvider() - Constructor for class springfox.documentation.swagger.schema.ApiModelTypeNameProvider
 
ApiOperationReader - Class in springfox.documentation.spring.web.readers.operation
 
ApiOperationReader(DocumentationPluginsManager, OperationNameGenerator) - Constructor for class springfox.documentation.spring.web.readers.operation.ApiOperationReader
 
ApiParamParameterBuilder - Class in springfox.documentation.swagger.readers.parameter
 
ApiParamParameterBuilder(DescriptionResolver, EnumTypeDeterminer) - Constructor for class springfox.documentation.swagger.readers.parameter.ApiParamParameterBuilder
 
apiPathCompatator() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
ApiResourceController - Class in springfox.documentation.swagger.web
 
ApiResourceController(SwaggerResourcesProvider) - Constructor for class springfox.documentation.swagger.web.ApiResourceController
 
apis(List<ApiDescription>) - Method in class springfox.documentation.builders.ApiListingBuilder
Updates the apis
apis(List<ApiListingReference>) - Method in class springfox.documentation.builders.ResourceListingBuilder
Updates the api listed within this resource listing
apis(Predicate<RequestHandler>) - Method in class springfox.documentation.spring.web.plugins.ApiSelectorBuilder
 
ApiSelector - Class in springfox.documentation.spi.service.contexts
 
ApiSelector(Predicate<RequestHandler>, Predicate<String>) - Constructor for class springfox.documentation.spi.service.contexts.ApiSelector
 
ApiSelectorBuilder - Class in springfox.documentation.spring.web.plugins
 
ApiSelectorBuilder(Docket) - Constructor for class springfox.documentation.spring.web.plugins.ApiSelectorBuilder
 
apiVersion(String) - Method in class springfox.documentation.builders.ApiListingBuilder
Updates the api version
apiVersion(String) - Method in class springfox.documentation.builders.ResourceListingBuilder
Updates the api version
appendApis(List<ApiDescription>) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
appendAuthorizations(List<Authorization>) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
appendConsumes(List<String>) - Method in class springfox.documentation.builders.ApiListingBuilder
Appends to the exiting collection of supported media types this listing consumes
appendConsumes(Set<String>) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
appendModels(Map<String, ModelDto>) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
appendProduces(List<String>) - Method in class springfox.documentation.builders.ApiListingBuilder
Appends to the exiting collection of supported media types this listing produces
appendProduces(Set<String>) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
appendProtocols(Set<String>) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
appliesTo(ResolvedType) - Method in class springfox.documentation.schema.AlternateTypeRule
Check if an alternate applies to type.
appliesTo(ResolvedType) - Method in class springfox.documentation.schema.RecursiveAlternateTypeRule
 
apply(ParameterExpansionContext) - Method in class springfox.bean.validators.plugins.parameter.ExpandedParameterMinMaxAnnotationPlugin
 
apply(ParameterExpansionContext) - Method in class springfox.bean.validators.plugins.parameter.ExpandedParameterNotNullAnnotationPlugin
 
apply(ParameterExpansionContext) - Method in class springfox.bean.validators.plugins.parameter.ExpandedParameterPatternAnnotationPlugin
 
apply(ParameterExpansionContext) - Method in class springfox.bean.validators.plugins.parameter.ExpandedParameterSizeAnnotationPlugin
 
apply(ParameterContext) - Method in class springfox.bean.validators.plugins.parameter.MinMaxAnnotationPlugin
 
apply(ParameterContext) - Method in class springfox.bean.validators.plugins.parameter.NotNullAnnotationPlugin
 
apply(ParameterContext) - Method in class springfox.bean.validators.plugins.parameter.PatternAnnotationPlugin
 
apply(ParameterContext) - Method in class springfox.bean.validators.plugins.parameter.SizeAnnotationPlugin
 
apply(ModelPropertyContext) - Method in class springfox.bean.validators.plugins.schema.DecimalMinMaxAnnotationPlugin
 
apply(ModelPropertyContext) - Method in class springfox.bean.validators.plugins.schema.MinMaxAnnotationPlugin
 
apply(ModelPropertyContext) - Method in class springfox.bean.validators.plugins.schema.NotNullAnnotationPlugin
read NotNull annotation
apply(ModelPropertyContext) - Method in class springfox.bean.validators.plugins.schema.PatternAnnotationPlugin
 
apply(ModelPropertyContext) - Method in class springfox.bean.validators.plugins.schema.SizeAnnotationPlugin
 
apply(DynamicType.Builder<Object>) - Method in class springfox.documentation.builders.AlternateTypePropertyBuilder
 
apply(ModelContext) - Method in class springfox.documentation.schema.plugins.PropertyDiscriminatorBasedInheritancePlugin
 
apply(ModelContext) - Method in class springfox.documentation.schema.plugins.XmlModelPlugin
 
apply(ModelPropertyContext) - Method in class springfox.documentation.schema.property.XmlPropertyPlugin
 
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
apply(OperationContext) - Method in class springfox.documentation.spring.web.plugins.SpringRestDocsOperationBuilderPlugin
 
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
 
apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.OperationAuthReader
 
apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.OperationHiddenReader
 
apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.OperationHttpMethodReader
 
apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.OperationImplicitParameterReader
 
apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.OperationImplicitParametersReader
 
apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.OperationNicknameIntoUniqueIdReader
 
apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.OperationNotesReader
 
apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.OperationPositionReader
 
apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.OperationSummaryReader
 
apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.SwaggerMediaTypeReader
 
apply(RequestMappingContext) - Method in class springfox.documentation.swagger.readers.operation.SwaggerOperationModelsProvider
 
apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.SwaggerOperationResponseClassReader
 
apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.SwaggerOperationTagsReader
 
apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.SwaggerResponseMessageReader
 
apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.VendorExtensionsReader
 
apply(ParameterContext) - Method in class springfox.documentation.swagger.readers.parameter.ApiParamParameterBuilder
 
apply(ParameterExpansionContext) - Method in class springfox.documentation.swagger.readers.parameter.SwaggerExpandedParameterBuilder
 
apply(ModelContext) - Method in class springfox.documentation.swagger.schema.ApiModelBuilder
 
apply(ModelPropertyContext) - Method in class springfox.documentation.swagger.schema.ApiModelPropertyPropertyBuilder
 
apply(ApiListingContext) - Method in class springfox.documentation.swagger.web.SwaggerApiListingReader
 
apply(ParameterContext) - Method in class springfox.documentation.swagger1.readers.parameter.ParameterNameReader
 
applyDefaultResponseMessages(boolean) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
appName(String) - Method in class springfox.documentation.swagger.web.SecurityConfigurationBuilder
 
associationMetadata() - Method in class springfox.documentation.spring.data.rest.EntityAssociationContext
 
attribute(Boolean) - Method in class springfox.documentation.schema.Xml
 
Authorization - Class in springfox.documentation.swagger1.dto
 
Authorization() - Constructor for class springfox.documentation.swagger1.dto.Authorization
 
Authorization(String, AuthorizationScope[]) - Constructor for class springfox.documentation.swagger1.dto.Authorization
 
AuthorizationCodeGrant - Class in springfox.documentation.service
 
AuthorizationCodeGrant(TokenRequestEndpoint, TokenEndpoint) - Constructor for class springfox.documentation.service.AuthorizationCodeGrant
 
AuthorizationCodeGrant - Class in springfox.documentation.swagger1.dto
 
AuthorizationCodeGrant() - Constructor for class springfox.documentation.swagger1.dto.AuthorizationCodeGrant
 
AuthorizationCodeGrant(TokenRequestEndpoint, TokenEndpoint) - Constructor for class springfox.documentation.swagger1.dto.AuthorizationCodeGrant
 
AuthorizationCodeGrantBuilder - Class in springfox.documentation.builders
 
AuthorizationCodeGrantBuilder() - Constructor for class springfox.documentation.builders.AuthorizationCodeGrantBuilder
 
authorizations(Collection<SecurityReference>) - Method in class springfox.documentation.builders.OperationBuilder
Updates the security checks that apply to this operation
AuthorizationScope - Class in springfox.documentation.service
 
AuthorizationScope(String, String) - Constructor for class springfox.documentation.service.AuthorizationScope
 
AuthorizationScope - Class in springfox.documentation.swagger1.dto
 
AuthorizationScope() - Constructor for class springfox.documentation.swagger1.dto.AuthorizationScope
 
AuthorizationScope(String, String) - Constructor for class springfox.documentation.swagger1.dto.AuthorizationScope
 
AuthorizationScopeBuilder - Class in springfox.documentation.builders
 
AuthorizationScopeBuilder() - Constructor for class springfox.documentation.builders.AuthorizationScopeBuilder
 
AuthorizationType - Class in springfox.documentation.swagger1.dto
 
AuthorizationType(String) - Constructor for class springfox.documentation.swagger1.dto.AuthorizationType
 
AuthorizationTypesMapper - Class in springfox.documentation.swagger1.mappers
 
AuthorizationTypesMapper() - Constructor for class springfox.documentation.swagger1.mappers.AuthorizationTypesMapper
 
availableTags(Set<Tag>) - Method in class springfox.documentation.builders.ApiListingBuilder
Globally configured tags

B

baseModel(String) - Method in class springfox.documentation.builders.ModelBuilder
Update the based model
BaseModelProperty - Class in springfox.documentation.schema.property
 
BaseModelProperty(String, TypeResolver, AlternateTypeProvider, BeanPropertyDefinition) - Constructor for class springfox.documentation.schema.property.BaseModelProperty
 
basePackage(String) - Static method in class springfox.documentation.builders.RequestHandlerSelectors
Predicate that matches RequestHandler with given base package name for the class of the handler method.
basePath(String) - Method in class springfox.documentation.builders.ApiListingBuilder
Updates base path for the api listing
basePath(String) - Method in class springfox.documentation.builders.DocumentationBuilder
Base path for this API
basePath() - Method in class springfox.documentation.spring.data.rest.EntityContext
 
BasePathAwareServicesProvider - Class in springfox.documentation.spring.data.rest
 
BasePathAwareServicesProvider(RepositoryRestConfiguration, ApplicationContext, HandlerMethodResolver, ServletContext) - Constructor for class springfox.documentation.spring.data.rest.BasePathAwareServicesProvider
 
BasicAuth - Class in springfox.documentation.service
 
BasicAuth(String) - Constructor for class springfox.documentation.service.BasicAuth
 
BasicAuth(String, List<VendorExtension>) - Constructor for class springfox.documentation.service.BasicAuth
 
BasicAuth - Class in springfox.documentation.swagger1.dto
 
BasicAuth() - Constructor for class springfox.documentation.swagger1.dto.BasicAuth
 
BEAN_VALIDATOR_PLUGIN_ORDER - Static variable in class springfox.bean.validators.plugins.Validators
 
BeanModelProperty - Class in springfox.documentation.schema.property.bean
 
BeanModelProperty(String, ResolvedMethod, TypeResolver, AlternateTypeProvider, BeanPropertyDefinition) - Constructor for class springfox.documentation.schema.property.bean.BeanModelProperty
 
beanPropertyByInternalName() - Static method in class springfox.documentation.schema.property.BeanPropertyDefinitions
 
BeanPropertyDefinitions - Class in springfox.documentation.schema.property
 
BeanPropertyNamingStrategy - Interface in springfox.documentation.schema.property
 
BeanValidatorPluginsConfiguration - Class in springfox.bean.validators.configuration
 
BeanValidatorPluginsConfiguration() - Constructor for class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
 
bootstrapDocumentationPlugins() - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
 
build() - Method in class springfox.documentation.builders.AlternateTypeBuilder
 
build() - Method in class springfox.documentation.builders.ApiDescriptionBuilder
 
build() - Method in class springfox.documentation.builders.ApiInfoBuilder
 
build() - Method in class springfox.documentation.builders.ApiListingBuilder
 
build() - Method in class springfox.documentation.builders.AuthorizationCodeGrantBuilder
 
build() - Method in class springfox.documentation.builders.AuthorizationScopeBuilder
 
build() - Method in class springfox.documentation.builders.DocumentationBuilder
 
build() - Method in class springfox.documentation.builders.ImplicitGrantBuilder
 
build() - Method in class springfox.documentation.builders.LoginEndpointBuilder
 
build() - Method in class springfox.documentation.builders.ModelBuilder
 
build() - Method in class springfox.documentation.builders.ModelPropertyBuilder
 
build() - Method in class springfox.documentation.builders.OAuthBuilder
 
build() - Method in class springfox.documentation.builders.OperationBuilder
 
build() - Method in class springfox.documentation.builders.ParameterBuilder
 
build() - Method in class springfox.documentation.builders.ResourceListingBuilder
 
build() - Method in class springfox.documentation.builders.ResponseMessageBuilder
 
build() - Method in class springfox.documentation.builders.TokenEndpointBuilder
 
build() - Method in class springfox.documentation.builders.TokenRequestEndpointBuilder
 
build() - Method in class springfox.documentation.service.SecurityReference.SecurityReferenceBuilder
 
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
 
build() - Method in class springfox.documentation.spring.web.plugins.ApiSelectorBuilder
 
build() - Method in class springfox.documentation.swagger.web.SecurityConfigurationBuilder
 
build() - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
 
buildContext(DocumentationPlugin) - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
 
builder() - Static method in class springfox.documentation.service.SecurityReference
 
builder() - Static method in class springfox.documentation.spi.service.contexts.SecurityContext
 
builder() - Static method in class springfox.documentation.swagger.web.SecurityConfigurationBuilder
 
builder() - Static method in class springfox.documentation.swagger.web.UiConfigurationBuilder
 
BuilderDefaults - Class in springfox.documentation.builders
This is a utility class with useful methods for builders
byListingPosition() - Static method in class springfox.documentation.builders.DocumentationBuilder
 
byOperationName() - Static method in interface springfox.documentation.RequestHandler
 
byOperationName() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
byPatternsCondition() - Static method in interface springfox.documentation.RequestHandler
 
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

Cacheable - Annotation Type in springfox.documentation.annotations
Annotation indicating that a method (or all the methods on a class) can be cached.
CachingModelDependencyProvider - Class in springfox.documentation.schema
 
CachingModelDependencyProvider(ModelDependencyProvider) - Constructor for class springfox.documentation.schema.CachingModelDependencyProvider
 
CachingModelPropertiesProvider - Class in springfox.documentation.schema.property
 
CachingModelPropertiesProvider(TypeResolver, ModelPropertiesProvider) - Constructor for class springfox.documentation.schema.property.CachingModelPropertiesProvider
 
CachingModelProvider - Class in springfox.documentation.schema
 
CachingModelProvider(ModelProvider) - Constructor for class springfox.documentation.schema.CachingModelProvider
 
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
 
canIgnore(ResolvedType) - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
Category - Class in springfox.petstore.model
 
Category(long, String) - Constructor for class springfox.petstore.model.Category
 
Category - Class in springfox.petstore.webflux.model
 
Category(long, String) - Constructor for class springfox.petstore.webflux.model.Category
 
childContext(String, ResolvedType, OperationContext) - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext
 
classByName(String) - Static method in class springfox.documentation.schema.ClassSupport
 
ClassOrApiAnnotationResourceGrouping - Class in springfox.documentation.swagger.web
Deprecated.
ClassOrApiAnnotationResourceGrouping() - Constructor for class springfox.documentation.swagger.web.ClassOrApiAnnotationResourceGrouping
Deprecated.
 
ClassSupport - Class in springfox.documentation.schema
 
clear() - Method in class springfox.documentation.spring.web.DocumentationCache
 
ClientCredentialsGrant - Class in springfox.documentation.service
 
ClientCredentialsGrant(String) - Constructor for class springfox.documentation.service.ClientCredentialsGrant
 
clientId(String) - Method in class springfox.documentation.swagger.web.SecurityConfigurationBuilder
 
clientIdName(String) - Method in class springfox.documentation.builders.TokenRequestEndpointBuilder
Updates the client id name
clientSecret(String) - Method in class springfox.documentation.swagger.web.SecurityConfigurationBuilder
 
clientSecretName(String) - Method in class springfox.documentation.builders.TokenRequestEndpointBuilder
Updates the client secret name
code(int) - Method in class springfox.documentation.builders.ResponseMessageBuilder
Updates the http response code
CodeGenGenericTypeNamingStrategy - Class in springfox.documentation.schema
 
CodeGenGenericTypeNamingStrategy() - Constructor for class springfox.documentation.schema.CodeGenGenericTypeNamingStrategy
 
codegenMethodNameStem(String) - Method in class springfox.documentation.builders.OperationBuilder
This is an optional override that provides a custom method name stem, such that the method name that is generated for the purposes of code-gen can be customized.
collectionElementType(ResolvedType) - Static method in class springfox.documentation.schema.Collections
 
collectionFormat(String) - Method in class springfox.documentation.builders.ParameterBuilder
Updates the parameter extensions
Collections - Class in springfox.documentation.schema
 
combine(RequestHandler) - Method in interface springfox.documentation.RequestHandler
This is to merge two request handlers that are indistinguishable other than the media types supported
combine(List<RequestHandler>) - Method in interface springfox.documentation.spi.service.RequestHandlerCombiner
 
combine(RequestHandler) - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
combine(PatternsRequestCondition<PatternsRequestCondition>) - Method in class springfox.documentation.spring.web.WebFluxPatternsRequestConditionWrapper
 
combine(RequestHandler) - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
combine(PatternsRequestCondition<PatternsRequestCondition>) - Method in class springfox.documentation.spring.web.WebMvcPatternsRequestConditionWrapper
 
combine(RequestHandler) - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
combine(PatternsRequestCondition<T>) - Method in interface springfox.documentation.spring.wrapper.PatternsRequestCondition
 
CombinedRequestHandler - Class in springfox.documentation.spring.web.plugins
 
CombinedRequestHandler(RequestHandler, RequestHandler) - Constructor for class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
compareTo(Version) - Method in class springfox.documentation.common.Version
 
compareTo(RequestHandler) - Method in interface springfox.documentation.RequestHandler
 
compareTo(SwaggerResource) - Method in class springfox.documentation.swagger.web.SwaggerResource
 
complexExamples(Map<String, List<Example>>) - Method in class springfox.documentation.builders.ParameterBuilder
 
componentsFrom(HttpServletRequest, String) - Static method in class springfox.documentation.swagger.common.HostNameProvider
 
configure(DocumentationContextBuilder) - Method in interface springfox.documentation.spi.service.DocumentationPlugin
Creates a documentation context based on a given DocumentationContextBuilder
configure(DocumentationContextBuilder) - Method in class springfox.documentation.spring.web.plugins.Docket
Builds the Docket by merging/overlaying user specified values.
Constants() - Constructor for class springfox.documentation.swagger.web.UiConfiguration.Constants
 
constructors(ResolvedType) - Method in class springfox.documentation.schema.property.FactoryMethodProvider
 
consumes(Set<String>) - Method in class springfox.documentation.builders.ApiListingBuilder
Replaces the existing media types with new entries that this documentation consumes
consumes(Set<String>) - Method in class springfox.documentation.builders.DocumentationBuilder
Updates the existing media types with new entries that this documentation consumes
consumes(Set<String>) - Method in class springfox.documentation.builders.OperationBuilder
Updates the existing media types with new entries that this documentation consumes
consumes() - Method in interface springfox.documentation.RequestHandler
 
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
 
consumes() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
consumes(Set<String>) - Method in class springfox.documentation.spring.web.plugins.Docket
 
consumes() - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
consumes() - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
contact(String) - Method in class springfox.documentation.builders.ApiInfoBuilder
Deprecated.
@since 2.4.0. Use the overload that takes in a contact instead
contact(Contact) - Method in class springfox.documentation.builders.ApiInfoBuilder
Updates contact information for the person responsible for this API
Contact - Class in springfox.documentation.service
 
Contact(String, String, String) - Constructor for class springfox.documentation.service.Contact
 
ContainerDataType - Class in springfox.documentation.swagger1.dto
 
ContainerDataType(String, boolean) - Constructor for class springfox.documentation.swagger1.dto.ContainerDataType
 
containerType(ResolvedType) - Static method in class springfox.documentation.schema.Collections
 
contextPath() - Method in class springfox.documentation.spring.data.rest.EntityContext
 
contextPath(ServletContext) - Static method in class springfox.documentation.spring.web.paths.Paths
 
contextRefreshedEventExecute() - Method in class springfox.documentation.spring.web.plugins.SpringIntegrationDocumentationPluginsBootstrapper
 
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
 
convert(Object) - Method in class springfox.documentation.spring.data.rest.OptionalDeferencer
 
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
create(DocumentationType) - Method in class springfox.documentation.spring.web.plugins.DefaultConfiguration
 
create(DocumentationType) - Method in class springfox.documentation.swagger1.web.SwaggerDefaultConfiguration
 
create(long, String) - Static method in class springfox.petstore.model.Category
 
create(long, String) - Static method in class springfox.petstore.webflux.model.Category
 
createContextBuilder(DocumentationType, DefaultsProviderPlugin) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 
createUser(User) - Method in class springfox.petstore.controller.UserController
 
createUser(User) - Method in class springfox.petstore.webflux.controller.UserController
 
createUsersWithArrayInput(User[]) - Method in class springfox.petstore.controller.UserController
 
createUsersWithArrayInput(User[]) - Method in class springfox.petstore.webflux.controller.UserController
 
createUsersWithListInput(List<User>) - Method in class springfox.petstore.controller.UserController
 
createUsersWithListInput(List<User>) - Method in class springfox.petstore.webflux.controller.UserController
 
CredentialsGrant - Class in springfox.documentation.service
 
CredentialsGrant(String, String) - Constructor for class springfox.documentation.service.CredentialsGrant
 
crudMethods() - Method in class springfox.documentation.spring.data.rest.EntityContext
 

D

DataType - Class in springfox.documentation.swagger1.dto
 
DataType(String) - Constructor for class springfox.documentation.swagger1.dto.DataType
 
DataTypeMapper - Class in springfox.documentation.swagger1.mappers
 
DataTypeMapper() - Constructor for class springfox.documentation.swagger1.mappers.DataTypeMapper
 
DataTypeMapper.ItemType - Annotation Type in springfox.documentation.swagger1.mappers
 
DataTypeMapper.OperationType - Annotation Type in springfox.documentation.swagger1.mappers
 
DataTypeMapper.ResponseTypeName - Annotation Type in springfox.documentation.swagger1.mappers
 
DataTypeMapper.Type - Annotation Type in springfox.documentation.swagger1.mappers
 
DecimalMinMaxAnnotationPlugin - Class in springfox.bean.validators.plugins.schema
 
DecimalMinMaxAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.schema.DecimalMinMaxAnnotationPlugin
 
decimalMinMaxPlugin() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
 
declaringClass() - Method in interface springfox.documentation.RequestHandler
Deprecated.
@since 2.7.0 This is introduced to preserve backwards compat with groups
declaringClass() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
declaringClass() - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
declaringClass() - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
decode(String) - Static method in class springfox.documentation.spring.web.ControllerNamingUtils
 
decorator(PathContext) - Method in interface springfox.documentation.service.PathDecorator
 
decorator(PathContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 
deepLinking(Boolean) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
 
DEFAULT - Static variable in class springfox.documentation.service.ApiInfo
 
DEFAULT - Static variable in class springfox.documentation.spi.service.contexts.ApiSelector
 
DEFAULT_CONTACT - Static variable in class springfox.documentation.service.ApiInfo
 
DEFAULT_GROUP_NAME - Static variable in class springfox.documentation.spring.web.plugins.Docket
 
DEFAULT_PRECEDENCE - Static variable in class springfox.documentation.service.Parameter
 
DEFAULT_SUBMIT_METHODS - Static variable in class springfox.documentation.swagger.web.UiConfiguration.Constants
 
defaultConfiguration - Variable in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
 
DefaultConfiguration - Class in springfox.documentation.spring.web.plugins
 
DefaultConfiguration(Defaults, TypeResolver, PathProvider) - Constructor for class springfox.documentation.spring.web.plugins.DefaultConfiguration
 
defaultExcludeAnnotations() - Method in class springfox.documentation.spi.service.contexts.Defaults
 
DefaultGenericTypeNamingStrategy - Class in springfox.documentation.schema
Strategy that uses «, », and comma in generic type names
DefaultGenericTypeNamingStrategy() - Constructor for class springfox.documentation.schema.DefaultGenericTypeNamingStrategy
 
defaultIfAbsent(T, T) - Static method in class springfox.documentation.builders.BuilderDefaults
Returns this default value if the new value is null
defaultIgnorableParameterTypes() - Method in class springfox.documentation.spi.service.contexts.Defaults
 
DefaultModelDependencyProvider - Class in springfox.documentation.schema
 
DefaultModelDependencyProvider(TypeResolver, ModelPropertiesProvider, TypeNameExtractor, EnumTypeDeterminer, SchemaPluginsManager) - Constructor for class springfox.documentation.schema.DefaultModelDependencyProvider
 
defaultModelExpandDepth(Integer) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
 
DefaultModelProvider - Class in springfox.documentation.schema
 
DefaultModelProvider(TypeResolver, ModelPropertiesProvider, ModelDependencyProvider, SchemaPluginsManager, TypeNameExtractor, EnumTypeDeterminer) - Constructor for class springfox.documentation.schema.DefaultModelProvider
 
defaultModelRendering(ModelRendering) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
 
defaultModelsExpandDepth(Integer) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
 
defaultName() - Method in class springfox.documentation.service.ResolvedMethodParameter
 
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
 
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
 
defaults() - Method in class springfox.documentation.spring.web.SpringfoxWebConfiguration
 
DefaultsProviderPlugin - Interface in springfox.documentation.spi.service
 
DefaultTagsProvider - Class in springfox.documentation.spring.web.readers.operation
 
DefaultTagsProvider() - Constructor for class springfox.documentation.spring.web.readers.operation.DefaultTagsProvider
 
DefaultTypeNameProvider - Class in springfox.documentation.schema
 
DefaultTypeNameProvider() - Constructor for class springfox.documentation.schema.DefaultTypeNameProvider
 
defaultValue(String) - Method in class springfox.documentation.builders.ModelPropertyBuilder
 
defaultValue(String) - Method in class springfox.documentation.builders.ParameterBuilder
Updates the default value of the parameter
delegatedFactoryMethods(ResolvedType) - Method in class springfox.documentation.schema.property.FactoryMethodProvider
 
delete(K) - Method in class springfox.petstore.repository.MapBackedRepository
 
delete(K) - Method in class springfox.petstore.webflux.repository.MapBackedRepository
 
deleteOrder(String) - Method in class springfox.petstore.controller.PetStoreResource
 
deleteOrder(String) - Method in class springfox.petstore.webflux.controller.PetStoreResource
 
deleteUser(String) - Method in class springfox.petstore.controller.UserController
 
deleteUser(String) - Method in class springfox.petstore.webflux.controller.UserController
 
dependencies(ModelContext) - Method in class springfox.documentation.schema.CachingModelProvider
 
dependencies(ModelContext) - Method in class springfox.documentation.schema.DefaultModelProvider
 
dependencies(ModelContext) - Method in interface springfox.documentation.schema.ModelProvider
 
dependencies(ModelContext) - Method in class springfox.documentation.schema.plugins.SchemaPluginsManager
 
dependencies(ModelContext) - Method in interface springfox.documentation.spi.schema.SyntheticModelProviderPlugin
Creates a dependencies for the synthetic model
dependentModels(ModelContext) - Method in class springfox.documentation.schema.CachingModelDependencyProvider
 
dependentModels(ModelContext) - Method in class springfox.documentation.schema.DefaultModelDependencyProvider
 
dependentModels(ModelContext) - Method in interface springfox.documentation.schema.ModelDependencyProvider
 
deprecated(String) - Method in class springfox.documentation.builders.OperationBuilder
Marks the listing as deprecated
description(String) - Method in class springfox.documentation.builders.ApiDescriptionBuilder
Updates the descriptions to the api operation
description(String) - Method in class springfox.documentation.builders.ApiInfoBuilder
Updates the api description
description(String) - Method in class springfox.documentation.builders.ApiListingBuilder
Updates the description
description(String) - Method in class springfox.documentation.builders.AuthorizationScopeBuilder
Updates the description of the scope
description(String) - Method in class springfox.documentation.builders.ModelBuilder
Update the description of the model
description(String) - Method in class springfox.documentation.builders.ModelPropertyBuilder
 
description(String) - Method in class springfox.documentation.builders.ParameterBuilder
Updates the description of the parameter
description() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
description(RequestHandler) - Method in class springfox.documentation.spring.web.scanners.ApiDescriptionLookup
 
DescriptionResolver - Class in springfox.documentation.spring.web
 
DescriptionResolver(Environment) - Constructor for class springfox.documentation.spring.web.DescriptionResolver
 
descriptionResolver(Environment) - Method in class springfox.documentation.spring.web.SpringfoxWebConfiguration
 
descriptor(Map<String, Tag>, String) - Static method in class springfox.documentation.service.Tags
 
DIRECT_SUBSTITUTION_RULE_ORDER - Static variable in class springfox.documentation.schema.AlternateTypeRules
 
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
discriminator(String) - Method in class springfox.documentation.builders.ModelBuilder
Updates inheritance discriminator, used to identify inherited subclasses.
displayOperationId(Boolean) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
 
displayRequestDuration(Boolean) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
 
DocExpansion - Enum in springfox.documentation.swagger.web
 
docExpansion(DocExpansion) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
 
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
 
Documentation - Class in springfox.documentation.service
 
Documentation(String, String, Set<Tag>, Map<String, List<ApiListing>>, ResourceListing, Set<String>, Set<String>, String, Set<String>, Collection<VendorExtension>) - Constructor for class springfox.documentation.service.Documentation
 
DocumentationBuilder - Class in springfox.documentation.builders
 
DocumentationBuilder() - Constructor for class springfox.documentation.builders.DocumentationBuilder
 
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
 
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>, Comparator<ApiListingReference>, Comparator<ApiDescription>, Comparator<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
 
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 - Variable in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
 
DocumentationPluginsManager - Class in springfox.documentation.spring.web.plugins
 
DocumentationPluginsManager() - Constructor for class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 
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
 
doHash(RequestMappingContext) - Method in class springfox.documentation.spring.web.OperationCachingEquivalence
 

E

embeddedCollectionProvider(TypeResolver, RelProvider, TypeNameExtractor) - Method in class springfox.documentation.spring.data.rest.schema.SpringDataRestSchemaExtensions
 
emptyListValuesToNull(AllowableListValues) - Static method in class springfox.documentation.schema.Enums
 
emptyTags() - Static method in class springfox.documentation.service.Tags
 
emptyToNull(AllowableValues, AllowableValues) - Static method in class springfox.documentation.builders.BuilderDefaults
Retains current allowable values if then new value is null
enable(boolean) - Method in class springfox.documentation.spring.web.plugins.Docket
Hook to externally control auto initialization of this swagger plugin instance.
EnableSwagger - Annotation Type in springfox.documentation.swagger1.annotations
Indicates that Swagger support should be enabled.
EnableSwagger2WebFlux - Annotation Type in springfox.documentation.swagger2.annotations
Indicates that Swagger support should be enabled.
EnableSwagger2WebMvc - Annotation Type in springfox.documentation.swagger2.annotations
Indicates that Swagger support should be enabled.
enableUrlTemplating(boolean) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
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
 
entity() - Method in class springfox.documentation.spring.data.rest.EntityContext
 
EntityAssociationContext - Class in springfox.documentation.spring.data.rest
 
EntityAssociationContext(EntityContext, Association<? extends PersistentProperty<?>>) - Constructor for class springfox.documentation.spring.data.rest.EntityAssociationContext
 
EntityAssociationDeleteExtractor - Class in springfox.documentation.spring.data.rest
 
EntityAssociationDeleteExtractor() - Constructor for class springfox.documentation.spring.data.rest.EntityAssociationDeleteExtractor
 
EntityAssociationGetExtractor - Class in springfox.documentation.spring.data.rest
 
EntityAssociationGetExtractor() - Constructor for class springfox.documentation.spring.data.rest.EntityAssociationGetExtractor
 
EntityAssociationItemDeleteExtractor - Class in springfox.documentation.spring.data.rest
 
EntityAssociationItemDeleteExtractor() - Constructor for class springfox.documentation.spring.data.rest.EntityAssociationItemDeleteExtractor
 
EntityAssociationItemGetExtractor - Class in springfox.documentation.spring.data.rest
 
EntityAssociationItemGetExtractor() - Constructor for class springfox.documentation.spring.data.rest.EntityAssociationItemGetExtractor
 
EntityAssociationOperationsExtractor - Interface in springfox.documentation.spring.data.rest
 
EntityAssociationSaveExtractor - Class in springfox.documentation.spring.data.rest
 
EntityAssociationSaveExtractor() - Constructor for class springfox.documentation.spring.data.rest.EntityAssociationSaveExtractor
 
EntityAssociationsExtractor - Class in springfox.documentation.spring.data.rest
 
EntityAssociationsExtractor() - Constructor for class springfox.documentation.spring.data.rest.EntityAssociationsExtractor
 
EntityContext - Class in springfox.documentation.spring.data.rest
 
EntityContext(TypeResolver, String, RepositoryRestConfiguration, RepositoryInformation, Object, ResourceMetadata, ResourceMappings, PersistentEntities, Associations, RequestHandlerExtractorConfiguration) - Constructor for class springfox.documentation.spring.data.rest.EntityContext
 
EntityOperationsExtractor - Interface in springfox.documentation.spring.data.rest
 
Entry<K,V> - Class in springfox.documentation.schema
 
Entry() - Constructor for class springfox.documentation.schema.Entry
 
EnumMapper - Class in springfox.documentation.swagger2.mappers
 
EnumMapper() - Constructor for class springfox.documentation.swagger2.mappers.EnumMapper
 
Enums - Class in springfox.documentation.schema
 
EnumTypeDeterminer - Interface in springfox.documentation.spi.schema
 
equals(Object) - Method in class springfox.documentation.common.Version
 
equals(Object) - Method in class springfox.documentation.RequestHandlerKey
 
equals(Object) - Method in class springfox.documentation.schema.Xml
 
equals(Object) - Method in class springfox.documentation.service.Header
 
equals(Object) - Method in class springfox.documentation.service.ObjectVendorExtension
 
equals(Object) - Method in class springfox.documentation.service.ResourceGroup
 
equals(Object) - Method in class springfox.documentation.service.ResponseMessage
 
equals(Object) - Method in class springfox.documentation.service.StringVendorExtension
 
equals(Object) - Method in class springfox.documentation.service.Tag
 
equals(Object) - Method in class springfox.documentation.spi.DocumentationType
 
equals(Object) - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
equals(Object) - Method in class springfox.documentation.spring.web.OperationCachingEquivalence.Wrapper
 
equals(Object) - Method in class springfox.documentation.spring.web.WebFluxNameValueExpressionWrapper
 
equals(Object) - Method in class springfox.documentation.spring.web.WebFluxPatternsRequestConditionWrapper
 
equals(Object) - Method in class springfox.documentation.spring.web.WebMvcNameValueExpressionWrapper
 
equals(Object) - Method in class springfox.documentation.spring.web.WebMvcPatternsRequestConditionWrapper
 
exactMatch(ResolvedType, ResolvedType) - Static method in class springfox.documentation.schema.WildcardType
 
example(String) - Method in class springfox.documentation.builders.ModelBuilder
Deprecated.
@since 2.8.1 Use the one which takes in an Object instead
example(Object) - Method in class springfox.documentation.builders.ModelBuilder
Updates the Example for the model
example(String) - Method in class springfox.documentation.builders.ModelPropertyBuilder
Deprecated.
@since 2.8.1 Use the one with Object as parameter
example(Object) - Method in class springfox.documentation.builders.ModelPropertyBuilder
Updates the example
Example - Class in springfox.documentation.schema
 
Example(Object) - Constructor for class springfox.documentation.schema.Example
 
Example(String, Object) - Constructor for class springfox.documentation.schema.Example
 
example() - Method in class springfox.documentation.schema.property.BaseModelProperty
 
examples(List<Example>) - Method in class springfox.documentation.builders.ResponseMessageBuilder
Updates the response examples
Examples - Class in springfox.documentation.swagger.readers.parameter
 
examples(Example) - Static method in class springfox.documentation.swagger.readers.parameter.Examples
 
ExamplesMapper - Class in springfox.documentation.swagger2.mappers
 
ExamplesMapper() - Constructor for class springfox.documentation.swagger2.mappers.ExamplesMapper
 
exists(K) - Method in class springfox.petstore.repository.MapBackedRepository
 
exists(K) - Method in class springfox.petstore.webflux.repository.MapBackedRepository
 
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
 
ExpandedParameterBuilderPlugin - Interface in springfox.documentation.spi.service
 
ExpandedParameterMinMaxAnnotationPlugin - Class in springfox.bean.validators.plugins.parameter
 
ExpandedParameterMinMaxAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.parameter.ExpandedParameterMinMaxAnnotationPlugin
 
ExpandedParameterNotNullAnnotationPlugin - Class in springfox.bean.validators.plugins.parameter
 
ExpandedParameterNotNullAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.parameter.ExpandedParameterNotNullAnnotationPlugin
 
ExpandedParameterPatternAnnotationPlugin - Class in springfox.bean.validators.plugins.parameter
 
ExpandedParameterPatternAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.parameter.ExpandedParameterPatternAnnotationPlugin
 
ExpandedParameterSizeAnnotationPlugin - Class in springfox.bean.validators.plugins.parameter
 
ExpandedParameterSizeAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.parameter.ExpandedParameterSizeAnnotationPlugin
 
expanderMinMax() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
 
expanderNotNull() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
 
expanderPattern() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
 
expanderSize() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
 
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.builders.ApiInfoBuilder
Adds extensions for this API
extensions(List<VendorExtension>) - Method in class springfox.documentation.builders.DocumentationBuilder
Adds extensions for this API
extensions(List<VendorExtension>) - Method in class springfox.documentation.builders.ModelPropertyBuilder
 
extensions(List<VendorExtension>) - Method in class springfox.documentation.builders.OperationBuilder
Updates the operation extensions
extensions(List<VendorExtension>) - Method in class springfox.documentation.spring.web.plugins.Docket
Add to the api's vendor extensions
extract(EntityAssociationContext) - Method in class springfox.documentation.spring.data.rest.EntityAssociationDeleteExtractor
 
extract(EntityAssociationContext) - Method in class springfox.documentation.spring.data.rest.EntityAssociationGetExtractor
 
extract(EntityAssociationContext) - Method in class springfox.documentation.spring.data.rest.EntityAssociationItemDeleteExtractor
 
extract(EntityAssociationContext) - Method in class springfox.documentation.spring.data.rest.EntityAssociationItemGetExtractor
 
extract(EntityAssociationContext) - Method in interface springfox.documentation.spring.data.rest.EntityAssociationOperationsExtractor
 
extract(EntityAssociationContext) - Method in class springfox.documentation.spring.data.rest.EntityAssociationSaveExtractor
 
extract(EntityContext) - Method in class springfox.documentation.spring.data.rest.EntityAssociationsExtractor
 
extract(EntityContext) - Method in interface springfox.documentation.spring.data.rest.EntityOperationsExtractor
 
extractAnnotation(ModelPropertyContext, Class<T>) - Static method in class springfox.bean.validators.plugins.Validators
 

F

factory - Static variable in class springfox.documentation.swagger2.mappers.SerializableParameterFactories
 
FactoryMethodProvider - Class in springfox.documentation.schema.property
 
FactoryMethodProvider(TypeResolver) - Constructor for class springfox.documentation.schema.property.FactoryMethodProvider
 
FieldModelProperty - Class in springfox.documentation.schema.property.field
 
FieldModelProperty(String, ResolvedField, TypeResolver, AlternateTypeProvider, BeanPropertyDefinition) - Constructor for class springfox.documentation.schema.property.field.FieldModelProperty
 
FieldProvider - Class in springfox.documentation.schema.property.field
 
FieldProvider(TypeResolver) - Constructor for class springfox.documentation.schema.property.field.FieldProvider
 
filter(Object) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
 
findAllAnnotations(Class<T>) - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
findAnnotation(Class<T>) - Method in interface springfox.documentation.RequestHandler
 
findAnnotation(AnnotatedElement, Class<T>) - Static method in class springfox.documentation.schema.property.XmlPropertyPlugin
 
findAnnotation(Class<T>) - Method in class springfox.documentation.service.ResolvedMethodParameter
 
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
 
findAnnotation(Class<T>) - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
findAnnotation(Class<A>) - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterMetadataAccessor
 
findAnnotation(Class<T>) - Method in class springfox.documentation.spring.web.SpringIntegrationWebFluxRequestHandler
 
findAnnotation(Class<T>) - Method in class springfox.documentation.spring.web.SpringIntegrationWebMvcRequestHandler
 
findAnnotation(Class<T>) - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
findAnnotation(Class<T>) - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
findAnnotations(Class<T>) - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
findApiModePropertyAnnotation(AnnotatedElement) - Static method in class springfox.documentation.swagger.schema.ApiModelProperties
 
findApiParamAnnotation(AnnotatedElement) - Static method in class springfox.documentation.swagger.annotations.Annotations
 
findApiResponsesAnnotations(AnnotatedElement) - Static method in class springfox.documentation.swagger.annotations.Annotations
 
findControllerAnnotation(Class<T>) - Method in interface springfox.documentation.RequestHandler
 
findControllerAnnotation(Class<T>) - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
findControllerAnnotation(Class<T>) - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
findControllerAnnotation(Class<T>) - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
findControllerAnnotation(Class<T>) - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
findControllerAnnotation(Class<T>) - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
findParameterType(ParameterContext) - Static method in class springfox.documentation.spring.web.readers.parameter.ParameterTypeReader
 
findPetsByStatus(String) - Method in class springfox.petstore.controller.PetController
 
findPetsByStatus(String) - Method in class springfox.petstore.webflux.controller.PetController
 
findPetsByTags(String) - Method in class springfox.petstore.controller.PetController
Deprecated.
findPetsByTags(String) - Method in class springfox.petstore.webflux.controller.PetController
Deprecated.
findPetsHidden(String) - Method in class springfox.petstore.controller.PetController
 
findPetsHidden(String) - Method in class springfox.petstore.webflux.controller.PetController
 
findPropertyAnnotation(BeanPropertyDefinition, Class<A>) - Static method in class springfox.documentation.schema.Annotations
Finds first annotation of the given type on the given bean property and returns it.
first() - Method in class springfox.petstore.repository.MapBackedRepository
 
first() - Method in class springfox.petstore.webflux.repository.MapBackedRepository
 
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
forHttpMethods(Predicate<HttpMethod>) - Method in class springfox.documentation.spi.service.contexts.SecurityContextBuilder
 
forPaths(Predicate<String>) - Method in class springfox.documentation.spi.service.contexts.SecurityContextBuilder
 
from(Set<NameValueExpression<T>>) - Static method in class springfox.documentation.spring.web.WebFluxNameValueExpressionWrapper
 
from(Set<NameValueExpression<T>>) - Static method in class springfox.documentation.spring.web.WebMvcNameValueExpressionWrapper
 
fromHierarchy(MethodParameter, Class<A>) - Static method in class springfox.documentation.swagger.readers.parameter.ParameterAnnotationReader
 
fromParent(ModelContext, ResolvedType) - Static method in class springfox.documentation.spi.schema.contexts.ModelContext
Convenience method to provide an new context for an input parameter
fullyQualifiedClassName(String) - Method in class springfox.documentation.builders.AlternateTypeBuilder
 

G

GENERIC_SUBSTITUTION_RULE_ORDER - Static variable in class springfox.documentation.schema.AlternateTypeRules
 
genericModelSubstitutes(Class...) - Method in class springfox.documentation.spring.web.plugins.Docket
Substitutes each generic class with it's direct parameterized type.
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
get() - Method in class springfox.documentation.spring.web.OperationCachingEquivalence.Wrapper
 
get() - Method in class springfox.documentation.swagger.web.InMemorySwaggerResourcesProvider
 
get(K) - Method in class springfox.petstore.repository.MapBackedRepository
 
get(K) - Method in class springfox.petstore.webflux.repository.MapBackedRepository
 
getAbsoluteType() - Method in class springfox.documentation.swagger1.dto.ContainerDataType
 
getAbsoluteType() - Method in class springfox.documentation.swagger1.dto.DataType
 
getAbsoluteType() - Method in class springfox.documentation.swagger1.dto.PrimitiveDataType
 
getAbsoluteType() - Method in class springfox.documentation.swagger1.dto.PrimitiveFormatDataType
 
getAbsoluteType() - Method in class springfox.documentation.swagger1.dto.ReferenceDataType
 
getAbsoluteType() - Method in interface springfox.documentation.swagger1.dto.SwaggerDataType
 
getAdditionalModels() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getAdditionalModels() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getAdditionalQueryStringParams() - Method in class springfox.documentation.swagger.web.SecurityConfiguration
 
getAllowableValues() - Method in class springfox.documentation.schema.ModelProperty
 
getAllowableValues() - Method in class springfox.documentation.schema.ModelRef
 
getAllowableValues() - Method in interface springfox.documentation.schema.ModelReference
 
getAllowableValues() - Method in class springfox.documentation.service.Parameter
 
getAllowableValues() - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
 
getAllowableValues() - Method in class springfox.documentation.swagger1.dto.Parameter
 
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
 
getAnnotations() - Method in class springfox.documentation.service.ResolvedMethodParameter
 
getApiDescriptionOrdering() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getApiInfo() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getApiKey() - Method in class springfox.documentation.swagger.web.SecurityConfiguration
Deprecated.
@since 2.8.0
getApiKeyName() - Method in class springfox.documentation.swagger.web.SecurityConfiguration
Deprecated.
@since 2.8.0
getApiKeyVehicle() - Method in class springfox.documentation.swagger.web.SecurityConfiguration
Deprecated.
@since 2.8.0
getApiListing(String, String, HttpServletRequest) - Method in class springfox.documentation.swagger1.web.Swagger1Controller
 
getApiListings() - Method in class springfox.documentation.service.Documentation
 
getApis() - Method in class springfox.documentation.service.ApiListing
 
getApis() - Method in class springfox.documentation.service.ResourceListing
 
getApis() - Method in class springfox.documentation.swagger1.dto.ApiListing
 
getApis() - Method in class springfox.documentation.swagger1.dto.ResourceListing
 
getApiSelector() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getApisSorter() - Method in class springfox.documentation.swagger.web.UiConfiguration
Deprecated.
@since 2.8.0
getApiVersion() - Method in class springfox.documentation.service.ApiListing
 
getApiVersion() - Method in class springfox.documentation.service.ResourceListing
 
getApiVersion() - Method in class springfox.documentation.swagger1.dto.ApiListing
 
getApiVersion() - Method in class springfox.documentation.swagger1.dto.ResourceListing
 
getAppName() - Method in class springfox.documentation.swagger.web.SecurityConfiguration
 
getAssociation() - Method in class springfox.documentation.spring.data.rest.EntityAssociationContext
 
getAssociationExtractors() - Method in class springfox.documentation.spring.data.rest.EntityContext
 
getAssociationExtractors() - Method in interface springfox.documentation.spring.data.rest.RequestHandlerExtractorConfiguration
 
getAssociations() - Method in class springfox.documentation.spring.data.rest.EntityContext
 
getAttribute() - Method in class springfox.documentation.schema.Xml
 
getAuthorizations() - Method in class springfox.documentation.swagger1.dto.ApiListing
 
getAuthorizations() - Method in class springfox.documentation.swagger1.dto.Operation
 
getAuthorizations() - Method in class springfox.documentation.swagger1.dto.ResourceListing
 
getBaseModel() - Method in class springfox.documentation.schema.Model
 
getBaseModel() - Method in class springfox.documentation.swagger1.dto.ModelDto
 
getBasePath() - Method in class springfox.documentation.service.ApiListing
 
getBasePath() - Method in class springfox.documentation.service.Documentation
 
getBasePath() - Method in class springfox.documentation.swagger1.dto.ApiListing
 
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.
getCategory() - Method in class springfox.petstore.model.Pet
 
getCategory() - Method in class springfox.petstore.webflux.model.Pet
 
getClientId() - Method in class springfox.documentation.swagger.web.SecurityConfiguration
 
getClientIdName() - Method in class springfox.documentation.service.TokenRequestEndpoint
 
getClientIdName() - Method in class springfox.documentation.swagger1.dto.TokenRequestEndpoint
 
getClientSecret() - Method in class springfox.documentation.swagger.web.SecurityConfiguration
 
getClientSecretName() - Method in class springfox.documentation.service.TokenRequestEndpoint
 
getClientSecretName() - Method in class springfox.documentation.swagger1.dto.TokenRequestEndpoint
 
getCloseGeneric() - Method in class springfox.documentation.schema.CodeGenGenericTypeNamingStrategy
 
getCloseGeneric() - Method in class springfox.documentation.schema.DefaultGenericTypeNamingStrategy
 
getCloseGeneric() - Method in interface springfox.documentation.spi.schema.GenericTypeNamingStrategy
 
getCode() - Method in class springfox.documentation.service.ResponseMessage
 
getCode() - Method in class springfox.documentation.swagger1.dto.ResponseMessage
 
getCollectionFormat() - Method in class springfox.documentation.service.Parameter
 
getConfiguration() - Method in class springfox.documentation.spring.data.rest.EntityContext
 
getConsumes() - Method in class springfox.documentation.service.ApiListing
 
getConsumes() - Method in class springfox.documentation.service.Documentation
 
getConsumes() - Method in class springfox.documentation.service.Operation
 
getConsumes() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getConsumes() - Method in class springfox.documentation.swagger1.dto.ApiListing
 
getConsumes() - Method in class springfox.documentation.swagger1.dto.Operation
 
getContact() - Method in class springfox.documentation.service.ApiInfo
 
getContact() - Method in class springfox.documentation.swagger1.dto.ApiInfo
 
getControllerClass() - Method in class springfox.documentation.service.ResourceGroup
 
getDataTypeName() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
 
getDeepLinking() - Method in class springfox.documentation.swagger.web.UiConfiguration
 
getDefaultModelExpandDepth() - Method in class springfox.documentation.swagger.web.UiConfiguration
 
getDefaultModelRendering() - Method in class springfox.documentation.swagger.web.UiConfiguration
 
getDefaultModelsExpandDepth() - Method in class springfox.documentation.swagger.web.UiConfiguration
 
getDefaultValue() - Method in class springfox.documentation.schema.ModelProperty
 
getDefaultValue() - Method in class springfox.documentation.service.Parameter
 
getDefaultValue() - Method in class springfox.documentation.swagger1.dto.Parameter
 
getDeprecated() - Method in class springfox.documentation.service.Operation
 
getDeprecated() - Method in class springfox.documentation.swagger1.dto.Operation
 
getDescription() - Method in class springfox.documentation.schema.Model
 
getDescription() - Method in class springfox.documentation.schema.ModelProperty
 
getDescription() - Method in class springfox.documentation.service.ApiDescription
 
getDescription() - Method in class springfox.documentation.service.ApiInfo
 
getDescription() - Method in class springfox.documentation.service.ApiListing
 
getDescription() - Method in class springfox.documentation.service.ApiListingReference
 
getDescription() - Method in class springfox.documentation.service.AuthorizationScope
 
getDescription() - Method in class springfox.documentation.service.Header
 
getDescription() - Method in class springfox.documentation.service.Parameter
 
getDescription() - Method in class springfox.documentation.service.Tag
 
getDescription() - Method in class springfox.documentation.swagger1.dto.ApiDescription
 
getDescription() - Method in class springfox.documentation.swagger1.dto.ApiInfo
 
getDescription() - Method in class springfox.documentation.swagger1.dto.ApiListing
 
getDescription() - Method in class springfox.documentation.swagger1.dto.ApiListingReference
 
getDescription() - Method in class springfox.documentation.swagger1.dto.AuthorizationScope
 
getDescription() - Method in class springfox.documentation.swagger1.dto.ModelDto
 
getDescription() - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
 
getDescription() - Method in class springfox.documentation.swagger1.dto.Parameter
 
getDiscriminator() - Method in class springfox.documentation.schema.Model
 
getDiscriminator() - Method in class springfox.documentation.swagger1.dto.ModelDto
 
getDisplayOperationId() - Method in class springfox.documentation.swagger.web.UiConfiguration
 
getDisplayRequestDuration() - Method in class springfox.documentation.swagger.web.UiConfiguration
 
getDocExpansion() - Method in class springfox.documentation.swagger.web.UiConfiguration
 
getDocumentation(String, ServerHttpRequest) - Method in class springfox.documentation.swagger2.web.Swagger2ControllerWebFlux
 
getDocumentation(String, HttpServletRequest) - Method in class springfox.documentation.swagger2.web.Swagger2ControllerWebMvc
 
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
 
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.
getDocumentationType() - Method in class springfox.documentation.schema.ModelNameContext
 
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
 
getDocumentationType() - Method in class springfox.documentation.spring.web.plugins.Docket
 
getDocumentationType() - Method in class springfox.documentation.spring.web.scanners.ApiListingScanningContext
 
getEmail() - Method in class springfox.documentation.service.Contact
 
getEmail() - Method in class springfox.petstore.model.User
 
getEmail() - Method in class springfox.petstore.webflux.model.User
 
getEntityContext() - Method in class springfox.documentation.spring.data.rest.EntityAssociationContext
 
getEntityExtractors() - Method in interface springfox.documentation.spring.data.rest.RequestHandlerExtractorConfiguration
 
getErrorCode() - Method in exception springfox.petstore.webflux.controller.NotFoundException
 
getErrorMessage() - Method in exception springfox.petstore.webflux.controller.NotFoundException
 
getExample() - Method in class springfox.documentation.schema.Model
 
getExample() - Method in class springfox.documentation.schema.ModelProperty
 
getExamples() - Method in class springfox.documentation.service.Parameter
 
getExamples() - Method in class springfox.documentation.service.ResponseMessage
 
getExclusiveMax() - Method in class springfox.documentation.service.AllowableRangeValues
 
getExclusiveMin() - Method in class springfox.documentation.service.AllowableRangeValues
 
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
 
getFieldName() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterMetadataAccessor
 
getFieldType() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
 
getFieldType() - Method in interface springfox.documentation.spi.service.ParameterMetadataAccessor
 
getFieldType() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeField
 
getFieldType() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterMetadataAccessor
 
getFileExtension() - Method in class springfox.documentation.spring.web.SpringfoxTemplateFormat
 
getFilter() - Method in class springfox.documentation.swagger.web.UiConfiguration
 
getFirstName() - Method in class springfox.petstore.model.User
 
getFirstName() - Method in class springfox.petstore.webflux.model.User
 
getFormat() - Method in class springfox.documentation.swagger1.dto.PrimitiveFormatDataType
 
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
 
getGrantTypes() - Method in class springfox.documentation.service.OAuth
 
getGrantTypes() - Method in class springfox.documentation.swagger1.dto.OAuth
 
getGroupName() - Method in class springfox.documentation.service.ApiDescription
 
getGroupName() - Method in class springfox.documentation.service.Documentation
 
getGroupName() - Method in class springfox.documentation.service.ResourceGroup
 
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.
getGroupName() - Method in class springfox.documentation.spring.web.plugins.Docket
 
getHandlerMethod() - Method in interface springfox.documentation.RequestHandler
Deprecated.
This is introduced to preserve backwards compat
getHandlerMethod() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
getHandlerMethod() - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
getHandlerMethod() - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
getHeaders() - Method in class springfox.documentation.service.ResponseMessage
 
getHost() - Method in class springfox.documentation.service.ApiListing
 
getHost() - Method in class springfox.documentation.service.Documentation
 
getHost() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getId() - Method in class springfox.documentation.schema.Model
 
getId() - Method in class springfox.documentation.spring.web.SpringfoxTemplateFormat
 
getId() - Method in class springfox.documentation.swagger1.dto.ModelDto
 
getId() - Method in class springfox.petstore.model.Category
 
getId() - Method in class springfox.petstore.model.Order
 
getId() - Method in class springfox.petstore.model.Pet
 
getId() - Method in class springfox.petstore.model.Tag
 
getId() - Method in class springfox.petstore.model.User
 
getId() - Method in class springfox.petstore.webflux.model.Category
 
getId() - Method in class springfox.petstore.webflux.model.Order
 
getId() - Method in class springfox.petstore.webflux.model.Pet
 
getId() - Method in class springfox.petstore.webflux.model.Tag
 
getId() - Method in class springfox.petstore.webflux.model.User
 
getIdentifier() - Method in class springfox.petstore.model.Order
 
getIdentifier() - Method in class springfox.petstore.model.Pet
 
getIdentifier() - Method in class springfox.petstore.model.User
 
getIdentifier() - Method in interface springfox.petstore.repository.Identifiable
 
getIdentifier() - Method in class springfox.petstore.webflux.model.Order
 
getIdentifier() - Method in class springfox.petstore.webflux.model.Pet
 
getIdentifier() - Method in class springfox.petstore.webflux.model.User
 
getIdentifier() - Method in interface springfox.petstore.webflux.repository.Identifiable
 
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
 
getInfo() - Method in class springfox.documentation.service.ResourceListing
 
getInfo() - Method in class springfox.documentation.swagger1.dto.ResourceListing
 
getItems() - Method in class springfox.documentation.swagger1.dto.ContainerDataType
 
getItemType() - Method in class springfox.documentation.schema.ModelRef
 
getItemType() - Method in interface springfox.documentation.schema.ModelReference
 
getKey() - Method in class springfox.documentation.schema.Entry
 
getKeyname() - Method in class springfox.documentation.service.ApiKey
 
getKeyname() - Method in class springfox.documentation.swagger1.dto.ApiKey
 
getLastName() - Method in class springfox.petstore.model.User
 
getLastName() - Method in class springfox.petstore.webflux.model.User
 
getLicense() - Method in class springfox.documentation.service.ApiInfo
 
getLicense() - Method in class springfox.documentation.swagger1.dto.ApiInfo
 
getLicenseUrl() - Method in class springfox.documentation.service.ApiInfo
 
getLicenseUrl() - Method in class springfox.documentation.swagger1.dto.ApiInfo
 
getListingReferenceOrdering() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getLocation() - Method in class springfox.documentation.swagger.web.SwaggerResource
Deprecated.
@since 2.8.0 - Use url going forward
getLoginEndpoint() - Method in class springfox.documentation.service.ImplicitGrant
 
getLoginEndpoint() - Method in class springfox.documentation.swagger1.dto.ImplicitGrant
 
getMax() - Method in class springfox.documentation.service.AllowableRangeValues
 
getMax() - Method in class springfox.documentation.swagger1.dto.AllowableRangeValues
 
getMaxDisplayedTags() - Method in class springfox.documentation.swagger.web.UiConfiguration
 
getMediaType() - Method in class springfox.documentation.schema.Example
 
getMediaType() - Method in class springfox.documentation.spi.DocumentationType
 
getMessage() - Method in class springfox.documentation.service.ResponseMessage
 
getMessage() - Method in class springfox.documentation.swagger1.dto.ResponseMessage
 
getMethod() - Method in class springfox.documentation.service.Operation
 
getMethod() - Method in class springfox.documentation.swagger1.dto.Operation
 
getMethodsCondition() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getMethodSelector() - Method in class springfox.documentation.spi.service.contexts.SecurityContext
 
getMin() - Method in class springfox.documentation.service.AllowableRangeValues
 
getMin() - Method in class springfox.documentation.swagger1.dto.AllowableRangeValues
 
getModelMap() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getModelRef() - Method in class springfox.documentation.schema.ModelProperty
 
getModelRef() - Method in class springfox.documentation.service.Parameter
 
getModelReference() - Method in class springfox.documentation.service.Header
 
getModels() - Method in class springfox.documentation.service.ApiListing
 
getModels() - Method in class springfox.documentation.swagger1.dto.ApiListing
 
getName() - Method in interface springfox.documentation.RequestHandler
 
getName() - Method in class springfox.documentation.schema.Model
 
getName() - Method in class springfox.documentation.schema.ModelProperty
 
getName() - Method in class springfox.documentation.schema.property.BaseModelProperty
 
getName() - Method in interface springfox.documentation.schema.property.ModelProperty
 
getName() - Method in class springfox.documentation.schema.Xml
 
getName() - Method in class springfox.documentation.service.Contact
 
getName() - Method in class springfox.documentation.service.Header
 
getName() - Method in class springfox.documentation.service.ListVendorExtension
 
getName() - Method in class springfox.documentation.service.ObjectVendorExtension
 
getName() - Method in class springfox.documentation.service.Parameter
 
getName() - Method in class springfox.documentation.service.SecurityScheme
 
getName() - Method in class springfox.documentation.service.StringVendorExtension
 
getName() - Method in class springfox.documentation.service.Tag
 
getName() - Method in interface springfox.documentation.service.VendorExtension
 
getName() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
getName() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getName() - Method in class springfox.documentation.spring.data.rest.EntityContext
 
getName() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
getName() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeField
 
getName() - Method in class springfox.documentation.spring.web.SpringIntegrationWebFluxRequestHandler
 
getName() - Method in class springfox.documentation.spring.web.SpringIntegrationWebMvcRequestHandler
 
getName() - Method in class springfox.documentation.spring.web.WebFluxNameValueExpressionWrapper
 
getName() - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
getName() - Method in class springfox.documentation.spring.web.WebMvcNameValueExpressionWrapper
 
getName() - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
getName() - Method in interface springfox.documentation.spring.wrapper.NameValueExpression
 
getName() - Method in class springfox.documentation.swagger.web.SwaggerResource
 
getName() - Method in class springfox.documentation.swagger1.dto.AuthorizationType
 
getName() - Method in class springfox.documentation.swagger1.dto.ModelDto
 
getName() - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
 
getName() - Method in class springfox.documentation.swagger1.dto.OAuth
 
getName() - Method in class springfox.documentation.swagger1.dto.Parameter
 
getName() - Method in class springfox.petstore.model.Category
 
getName() - Method in class springfox.petstore.model.Pet
 
getName() - Method in class springfox.petstore.model.Tag
 
getName() - Method in class springfox.petstore.webflux.model.Category
 
getName() - Method in class springfox.petstore.webflux.model.Pet
 
getName() - Method in class springfox.petstore.webflux.model.Tag
 
getNamespace() - Method in class springfox.documentation.schema.Xml
 
getNickname() - Method in class springfox.documentation.swagger1.dto.Operation
 
getNotes() - Method in class springfox.documentation.service.Operation
 
getNotes() - Method in class springfox.documentation.swagger1.dto.Operation
 
getObjectMapper() - Method in class springfox.documentation.schema.configuration.ObjectMapperConfigured
 
getOpenGeneric() - Method in class springfox.documentation.schema.CodeGenGenericTypeNamingStrategy
 
getOpenGeneric() - Method in class springfox.documentation.schema.DefaultGenericTypeNamingStrategy
 
getOpenGeneric() - Method in interface springfox.documentation.spi.schema.GenericTypeNamingStrategy
 
getOperationContext() - Method in class springfox.documentation.spi.service.contexts.ParameterContext
 
getOperationContext() - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext
 
getOperationPath(String) - Method in interface springfox.documentation.PathProvider
Gets the sanitized and prepended with a "/" operation path
getOperationPath(String) - Method in class springfox.documentation.spring.web.paths.DefaultPathProvider
The relative path to the operation, from the basePath, which this operation describes.
getOperations() - Method in class springfox.documentation.service.ApiDescription
 
getOperations() - Method in class springfox.documentation.swagger1.dto.ApiDescription
 
getOperationsSorter() - Method in class springfox.documentation.swagger.web.UiConfiguration
 
getOrder() - Method in class springfox.documentation.schema.AlternateTypeRule
 
getOrder() - Method in class springfox.documentation.service.Parameter
 
getOrder() - Method in class springfox.documentation.service.Tag
 
getOrder() - Method in class springfox.documentation.spring.web.plugins.JacksonSerializerConvention
 
getOrderById(String) - Method in class springfox.petstore.controller.PetStoreResource
 
getOrderById(String) - Method in class springfox.petstore.webflux.controller.PetStoreResource
 
getOriginalInfo() - Method in class springfox.documentation.spring.web.WebMvcRequestMappingInfoWrapper
 
getOriginalInfo() - Method in interface springfox.documentation.spring.wrapper.RequestMappingInfo
 
getParamAccess() - Method in class springfox.documentation.service.Parameter
 
getParamAccess() - Method in class springfox.documentation.swagger1.dto.Parameter
 
getParameterBuilder() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
 
getParameterIndex() - Method in class springfox.documentation.service.ResolvedMethodParameter
 
getParameters() - Method in interface springfox.documentation.RequestHandler
 
getParameters() - Method in class springfox.documentation.service.Operation
 
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
 
getParameters() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
getParameters(BaseHttpInboundEndpoint) - Method in class springfox.documentation.spring.web.plugins.SpringIntegrationParametersProvider
 
getParameters(Set<NameValueExpression<String>>, String) - Method in class springfox.documentation.spring.web.readers.operation.AbstractOperationParameterRequestConditionReader
 
getParameters() - Method in class springfox.documentation.spring.web.SpringIntegrationWebFluxRequestHandler
 
getParameters() - Method in class springfox.documentation.spring.web.SpringIntegrationWebMvcRequestHandler
 
getParameters() - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
getParameters() - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
getParameters() - Method in class springfox.documentation.swagger1.dto.Operation
 
getParameterType() - Method in class springfox.documentation.service.ResolvedMethodParameter
 
getParameterType() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
 
getParameterType() - Method in class springfox.documentation.swagger1.dto.Parameter
 
getParamType() - Method in class springfox.documentation.service.Parameter
 
getParamType() - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext
 
getParamType() - Method in class springfox.documentation.swagger1.dto.Parameter
 
getParentName() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
 
getParentName() - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext
 
getPassAs() - Method in class springfox.documentation.service.ApiKey
 
getPassAs() - Method in class springfox.documentation.swagger1.dto.ApiKey
 
getPassword() - Method in class springfox.petstore.model.User
 
getPassword() - Method in class springfox.petstore.webflux.model.User
 
getPath() - Method in class springfox.documentation.service.ApiDescription
 
getPath() - Method in class springfox.documentation.service.ApiListingReference
 
getPath() - Method in class springfox.documentation.swagger1.dto.ApiDescription
 
getPath() - Method in class springfox.documentation.swagger1.dto.ApiListingReference
 
getPathMapping() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getPathMappings() - Method in class springfox.documentation.RequestHandlerKey
 
getPathProvider() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getPathSelector() - Method in class springfox.documentation.spi.service.contexts.ApiSelector
 
getPattern() - Method in class springfox.documentation.schema.ModelProperty
 
getPattern() - Method in class springfox.documentation.service.Parameter
 
getPatterns() - Method in class springfox.documentation.spring.web.WebFluxPatternsRequestConditionWrapper
 
getPatterns() - Method in class springfox.documentation.spring.web.WebMvcPatternsRequestConditionWrapper
 
getPatterns() - Method in interface springfox.documentation.spring.wrapper.PatternsRequestCondition
 
getPatternsCondition() - Method in interface springfox.documentation.RequestHandler
 
getPatternsCondition() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getPatternsCondition() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
getPatternsCondition() - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
getPatternsCondition() - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
getPetById(String) - Method in class springfox.petstore.controller.PetController
 
getPetById(String) - Method in class springfox.petstore.webflux.controller.PetController
 
getPetId() - Method in class springfox.petstore.model.Order
 
getPetId() - Method in class springfox.petstore.webflux.model.Order
 
getPetInCA() - Method in class springfox.petstore.controller.PetStoreResource
 
getPetInCA() - Method in class springfox.petstore.webflux.controller.PetStoreResource
 
getPetInTx() - Method in class springfox.petstore.controller.PetStoreResource
 
getPetInTx() - Method in class springfox.petstore.webflux.controller.PetStoreResource
 
getPhase() - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
 
getPhone() - Method in class springfox.petstore.model.User
 
getPhone() - Method in class springfox.petstore.webflux.model.User
 
getPhotoUrls() - Method in class springfox.petstore.model.Pet
 
getPhotoUrls() - Method in class springfox.petstore.webflux.model.Pet
 
getPosition() - Method in class springfox.documentation.schema.ModelProperty
 
getPosition() - Method in class springfox.documentation.service.ApiListing
 
getPosition() - Method in class springfox.documentation.service.ApiListingReference
 
getPosition() - Method in class springfox.documentation.service.Operation
 
getPosition() - Method in class springfox.documentation.service.ResourceGroup
 
getPosition() - Method in class springfox.documentation.swagger1.dto.ApiListing
 
getPosition() - Method in class springfox.documentation.swagger1.dto.ApiListingReference
 
getPosition() - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
 
getPosition() - Method in class springfox.documentation.swagger1.dto.Operation
 
getPrefix() - Method in class springfox.documentation.schema.Xml
 
getProduces() - Method in class springfox.documentation.service.ApiListing
 
getProduces() - Method in class springfox.documentation.service.Documentation
 
getProduces() - Method in class springfox.documentation.service.Operation
 
getProduces() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getProduces() - Method in class springfox.documentation.swagger1.dto.ApiListing
 
getProduces() - Method in class springfox.documentation.swagger1.dto.Operation
 
getProducibleMediaTypes() - Method in class springfox.documentation.RequestHandlerKey
 
getProperties() - Method in class springfox.documentation.schema.Model
 
getProperties() - Method in class springfox.documentation.swagger1.dto.ModelDto
 
getProtocol() - Method in class springfox.documentation.service.Operation
 
getProtocol() - Method in class springfox.documentation.swagger1.dto.Operation
 
getProtocols() - Method in class springfox.documentation.service.ApiListing
 
getProtocols() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getProtocols() - Method in class springfox.documentation.swagger1.dto.ApiListing
 
getQualifiedType() - Method in class springfox.documentation.schema.Model
 
getQualifiedType() - Method in class springfox.documentation.schema.ModelProperty
 
getQualifiedType() - Method in class springfox.documentation.swagger1.dto.ModelDto
 
getQualifiedType() - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
 
getQuantity() - Method in class springfox.petstore.model.Order
 
getQuantity() - Method in class springfox.petstore.webflux.model.Order
 
getRealm() - Method in class springfox.documentation.swagger.web.SecurityConfiguration
 
getReference() - Method in class springfox.documentation.service.SecurityReference
 
getReference() - Method in class springfox.documentation.swagger1.dto.ReferenceDataType
 
getRepositoryInstance() - Method in class springfox.documentation.spring.data.rest.EntityContext
 
getRepositoryMetadata() - Method in class springfox.documentation.spring.data.rest.EntityContext
 
getRequestHandlers() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getRequestHandlerSelector() - Method in class springfox.documentation.spi.service.contexts.ApiSelector
 
getRequestMapping() - Method in interface springfox.documentation.RequestHandler
Deprecated.
This is introduced to preserve backwards compat
getRequestMapping() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
getRequestMapping() - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
getRequestMapping() - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
getRequestMappingPattern() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getRequestMappingsByResourceGroup() - Method in class springfox.documentation.spring.web.scanners.ApiListingScanningContext
 
getRequestTimeout() - Method in class springfox.documentation.swagger.web.UiConfiguration
Deprecated.
@since 2.8.0
getResolvedMembers() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeField
 
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
getResourceDescription(RequestMappingInfo, HandlerMethod) - Method in class springfox.documentation.spring.web.SpringGroupingStrategy
 
getResourceDescription(RequestMappingInfo, HandlerMethod) - Method in class springfox.documentation.swagger.web.ClassOrApiAnnotationResourceGrouping
Deprecated.
 
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
getResourceGroupRequestMappings() - Method in class springfox.documentation.spring.web.scanners.ApiListingReferenceScanResult
 
getResourceGroups(RequestMappingInfo, HandlerMethod) - Method in interface springfox.documentation.spi.service.ResourceGroupingStrategy
Deprecated.
Gets the resource group for a particular request mapping.
getResourceGroups(RequestMappingInfo, HandlerMethod) - Method in class springfox.documentation.spring.web.SpringGroupingStrategy
 
getResourceGroups(RequestMappingInfo, HandlerMethod) - Method in class springfox.documentation.swagger.web.ClassOrApiAnnotationResourceGrouping
Deprecated.
 
getResourceListing() - Method in class springfox.documentation.service.Documentation
 
getResourceListing(String) - Method in class springfox.documentation.swagger1.web.Swagger1Controller
 
getResourceListingPath(String, String) - Method in interface springfox.documentation.PathProvider
Gets the resource listing path given a group name and api
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).
getResourcePath() - Method in class springfox.documentation.service.ApiListing
 
getResourcePath() - Method in class springfox.documentation.swagger1.dto.ApiListing
 
getResourcePosition(RequestMappingInfo, HandlerMethod) - Method in interface springfox.documentation.spi.service.ResourceGroupingStrategy
Deprecated.
@since 2.0.2
getResourcePosition(RequestMappingInfo, HandlerMethod) - Method in class springfox.documentation.spring.web.SpringGroupingStrategy
 
getResourcePosition(RequestMappingInfo, HandlerMethod) - Method in class springfox.documentation.swagger.web.ClassOrApiAnnotationResourceGrouping
Deprecated.
 
getResponseMessages() - Method in class springfox.documentation.service.Operation
 
getResponseMessages() - Method in class springfox.documentation.swagger1.dto.Operation
 
getResponseModel() - Method in class springfox.documentation.service.Operation
 
getResponseModel() - Method in class springfox.documentation.service.ResponseMessage
 
getResponseModel() - Method in class springfox.documentation.swagger1.dto.ResponseMessage
 
getReturnType() - Method in interface springfox.documentation.RequestHandler
 
getReturnType() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
getReturnType() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
getReturnType() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
getReturnType() - Method in class springfox.documentation.spring.web.SpringIntegrationWebFluxRequestHandler
 
getReturnType() - Method in class springfox.documentation.spring.web.SpringIntegrationWebMvcRequestHandler
 
getReturnType() - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
getReturnType() - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
getScalarExample() - Method in class springfox.documentation.service.Parameter
 
getSchemes() - Method in class springfox.documentation.service.Documentation
 
getScope() - Method in class springfox.documentation.service.AuthorizationScope
 
getScope() - Method in class springfox.documentation.swagger1.dto.AuthorizationScope
 
getScopes() - Method in class springfox.documentation.service.OAuth
 
getScopes() - Method in class springfox.documentation.service.SecurityReference
 
getScopes() - Method in class springfox.documentation.swagger1.dto.Authorization
 
getScopes() - Method in class springfox.documentation.swagger1.dto.OAuth
 
getSecurityContexts() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getSecurityReferences() - Method in class springfox.documentation.service.ApiListing
 
getSecurityReferences() - Method in class springfox.documentation.service.Operation
 
getSecurityReferences() - Method in class springfox.documentation.spi.service.contexts.SecurityContext
 
getSecuritySchemes() - Method in class springfox.documentation.service.ResourceListing
 
getSecuritySchemes() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getShipDate() - Method in class springfox.petstore.model.Order
 
getShipDate() - Method in class springfox.petstore.webflux.model.Order
 
getShowExtensions() - Method in class springfox.documentation.swagger.web.UiConfiguration
 
getStatus() - Method in class springfox.petstore.model.Order
 
getStatus() - Method in class springfox.petstore.model.Pet
 
getStatus() - Method in class springfox.petstore.webflux.model.Order
 
getStatus() - Method in class springfox.petstore.webflux.model.Pet
 
getSubTypes() - Method in class springfox.documentation.schema.Model
 
getSubTypes() - Method in class springfox.documentation.swagger1.dto.ModelDto
 
getSummary() - Method in class springfox.documentation.service.Operation
 
getSummary() - Method in class springfox.documentation.swagger1.dto.Operation
 
getSupportedMediaTypes() - Method in class springfox.documentation.RequestHandlerKey
 
getSupportedMethods() - Method in class springfox.documentation.RequestHandlerKey
 
getSupportedSubmitMethods() - Method in class springfox.documentation.swagger.web.UiConfiguration
 
getSwaggerVersion() - Method in class springfox.documentation.swagger.web.SwaggerResource
 
getSwaggerVersion() - Method in class springfox.documentation.swagger1.dto.ApiListing
 
getSwaggerVersion() - Method in class springfox.documentation.swagger1.dto.ResourceListing
 
getTags() - Method in class springfox.documentation.service.ApiListing
 
getTags() - Method in class springfox.documentation.service.Documentation
 
getTags() - Method in class springfox.documentation.service.Operation
 
getTags() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getTags() - Method in class springfox.petstore.model.Pet
 
getTags() - Method in class springfox.petstore.webflux.model.Pet
 
getTagsSorter() - Method in class springfox.documentation.swagger.web.UiConfiguration
 
getTermsOfServiceUrl() - Method in class springfox.documentation.service.ApiInfo
 
getTermsOfServiceUrl() - Method in class springfox.documentation.swagger1.dto.ApiInfo
 
getTitle() - Method in class springfox.documentation.service.ApiInfo
 
getTitle() - Method in class springfox.documentation.swagger1.dto.ApiInfo
 
getTokenEndpoint() - Method in class springfox.documentation.service.AuthorizationCodeGrant
 
getTokenEndpoint() - Method in class springfox.documentation.swagger1.dto.AuthorizationCodeGrant
 
getTokenName() - Method in class springfox.documentation.service.ImplicitGrant
 
getTokenName() - Method in class springfox.documentation.service.TokenEndpoint
 
getTokenName() - Method in class springfox.documentation.swagger1.dto.ImplicitGrant
 
getTokenName() - Method in class springfox.documentation.swagger1.dto.TokenEndpoint
 
getTokenRequestEndpoint() - Method in class springfox.documentation.service.AuthorizationCodeGrant
 
getTokenRequestEndpoint() - Method in class springfox.documentation.swagger1.dto.AuthorizationCodeGrant
 
getTokenUrl() - Method in class springfox.documentation.service.CredentialsGrant
 
getType() - Method in class springfox.documentation.schema.Model
 
getType() - Method in class springfox.documentation.schema.ModelNameContext
 
getType() - Method in class springfox.documentation.schema.ModelProperty
 
getType() - Method in class springfox.documentation.schema.ModelRef
 
getType() - Method in interface springfox.documentation.schema.ModelReference
 
getType() - Method in class springfox.documentation.schema.property.BaseModelProperty
 
getType() - Method in interface springfox.documentation.schema.property.ModelProperty
 
getType() - Method in class springfox.documentation.service.GrantType
 
getType() - Method in class springfox.documentation.service.Parameter
 
getType() - Method in class springfox.documentation.service.SecurityScheme
 
getType() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
getType() - Method in class springfox.documentation.swagger1.dto.Authorization
 
getType() - Method in class springfox.documentation.swagger1.dto.AuthorizationType
 
getType() - Method in class springfox.documentation.swagger1.dto.ContainerDataType
 
getType() - Method in class springfox.documentation.swagger1.dto.GrantType
 
getType() - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
 
getType() - Method in class springfox.documentation.swagger1.dto.PrimitiveDataType
 
getType() - Method in class springfox.documentation.swagger1.dto.PrimitiveFormatDataType
 
getTypeListDelimiter() - Method in class springfox.documentation.schema.CodeGenGenericTypeNamingStrategy
 
getTypeListDelimiter() - Method in class springfox.documentation.schema.DefaultGenericTypeNamingStrategy
 
getTypeListDelimiter() - Method in interface springfox.documentation.spi.schema.GenericTypeNamingStrategy
 
getTypeResolver() - Method in class springfox.documentation.spring.data.rest.EntityContext
 
getUniqueId() - Method in class springfox.documentation.service.Operation
 
getUrl() - Method in class springfox.documentation.service.Contact
 
getUrl() - Method in class springfox.documentation.service.LoginEndpoint
 
getUrl() - Method in class springfox.documentation.service.TokenEndpoint
 
getUrl() - Method in class springfox.documentation.service.TokenRequestEndpoint
 
getUrl() - Method in class springfox.documentation.swagger.web.SwaggerResource
Use url going forward rather than location
getUrl() - Method in class springfox.documentation.swagger1.dto.LoginEndpoint
 
getUrl() - Method in class springfox.documentation.swagger1.dto.TokenEndpoint
 
getUrl() - Method in class springfox.documentation.swagger1.dto.TokenRequestEndpoint
 
getUseBasicAuthenticationWithAccessCodeGrant() - Method in class springfox.documentation.swagger.web.SecurityConfiguration
 
getUserByName(String) - Method in class springfox.petstore.controller.UserController
 
getUserByName(String) - Method in class springfox.petstore.webflux.controller.UserController
 
getUsername() - Method in class springfox.petstore.model.User
 
getUsername() - Method in class springfox.petstore.webflux.model.User
 
getUserStatus() - Method in class springfox.petstore.model.User
 
getUserStatus() - Method in class springfox.petstore.webflux.model.User
 
getValidatorUrl() - Method in class springfox.documentation.swagger.web.UiConfiguration
 
getValue() - Method in class springfox.documentation.schema.Example
 
getValue() - Method in class springfox.documentation.service.ListVendorExtension
 
getValue() - Method in class springfox.documentation.service.ObjectVendorExtension
 
getValue() - Method in class springfox.documentation.service.StringVendorExtension
 
getValue() - Method in interface springfox.documentation.service.VendorExtension
 
getValue() - Method in class springfox.documentation.spring.web.WebFluxNameValueExpressionWrapper
 
getValue() - Method in class springfox.documentation.spring.web.WebMvcNameValueExpressionWrapper
 
getValue() - Method in interface springfox.documentation.spring.wrapper.NameValueExpression
 
getValue() - Method in enum springfox.documentation.swagger.web.ApiKeyVehicle
 
getValue() - Method in enum springfox.documentation.swagger.web.DocExpansion
 
getValue() - Method in enum springfox.documentation.swagger.web.ModelRendering
 
getValue() - Method in enum springfox.documentation.swagger.web.OperationsSorter
 
getValue() - Method in enum springfox.documentation.swagger.web.TagsSorter
 
getValues() - Method in class springfox.documentation.service.AllowableListValues
 
getValues() - Method in class springfox.documentation.swagger1.dto.AllowableListValues
 
getValueType() - Method in class springfox.documentation.service.AllowableListValues
 
getValueType() - Method in class springfox.documentation.swagger1.dto.AllowableListValues
 
getVendorExtensions() - Method in class springfox.documentation.schema.ModelProperty
 
getVendorExtensions() - Method in class springfox.documentation.service.ApiInfo
 
getVendorExtensions() - Method in class springfox.documentation.service.Documentation
 
getVendorExtensions() - Method in class springfox.documentation.service.Operation
 
getVendorExtensions() - Method in class springfox.documentation.service.ResponseMessage
 
getVendorExtensions() - Method in class springfox.documentation.service.SecurityScheme
 
getVendorExtensions() - Method in class springfox.documentation.service.Tag
 
getVendorExtentions() - Method in class springfox.documentation.service.Parameter
 
getVendorExtentions() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
getVersion() - Method in class springfox.documentation.common.SpringVersion
Return the full version string of the present Spring codebase, or null if it cannot be determined.
getVersion() - Method in class springfox.documentation.service.ApiInfo
 
getWrapped() - Method in class springfox.documentation.schema.Xml
 
getXml() - Method in class springfox.documentation.schema.Model
 
getXml() - Method in class springfox.documentation.schema.ModelProperty
 
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.
GrantType - Class in springfox.documentation.service
 
GrantType(String) - Constructor for class springfox.documentation.service.GrantType
 
GrantType - Class in springfox.documentation.swagger1.dto
 
GrantType() - Constructor for class springfox.documentation.swagger1.dto.GrantType
 
GrantType(String) - Constructor for class springfox.documentation.swagger1.dto.GrantType
 
grantTypes(List<GrantType>) - Method in class springfox.documentation.builders.OAuthBuilder
Updates the grant types that this security definition represents
groupName(String) - Method in class springfox.documentation.builders.ApiDescriptionBuilder
Updates the group name the api operation belongs to
groupName() - Method in interface springfox.documentation.RequestHandler
 
groupName(String) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
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.
groupName() - Method in class springfox.documentation.spring.web.SpringIntegrationWebFluxRequestHandler
 
groupName() - Method in class springfox.documentation.spring.web.SpringIntegrationWebMvcRequestHandler
 
groupName() - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
groupName() - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 

H

HandlerMethodResolver - Class in springfox.documentation.spring.web.readers.operation
 
HandlerMethodResolver(TypeResolver) - Constructor for class springfox.documentation.spring.web.readers.operation.HandlerMethodResolver
 
handlerProviders - Variable in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
 
hashCode() - Method in class springfox.documentation.common.Version
 
hashCode() - Method in class springfox.documentation.RequestHandlerKey
 
hashCode() - Method in class springfox.documentation.schema.Xml
 
hashCode() - Method in class springfox.documentation.service.Header
 
hashCode() - Method in class springfox.documentation.service.ObjectVendorExtension
 
hashCode() - Method in class springfox.documentation.service.ResourceGroup
 
hashCode() - Method in class springfox.documentation.service.ResponseMessage
 
hashCode() - Method in class springfox.documentation.service.StringVendorExtension
 
hashCode() - Method in class springfox.documentation.service.Tag
 
hashCode() - Method in class springfox.documentation.spi.DocumentationType
 
hashCode() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
hashCode() - Method in class springfox.documentation.spring.web.OperationCachingEquivalence.Wrapper
 
hashCode() - Method in class springfox.documentation.spring.web.WebFluxNameValueExpressionWrapper
 
hashCode() - Method in class springfox.documentation.spring.web.WebFluxPatternsRequestConditionWrapper
 
hashCode() - Method in class springfox.documentation.spring.web.WebMvcNameValueExpressionWrapper
 
hashCode() - Method in class springfox.documentation.spring.web.WebMvcPatternsRequestConditionWrapper
 
hasParameterAnnotation(Class<? extends Annotation>) - Method in class springfox.documentation.service.ResolvedMethodParameter
 
hasParameterAnnotations() - Method in class springfox.documentation.service.ResolvedMethodParameter
 
hasSeenBefore(ResolvedType) - Method in class springfox.documentation.spi.schema.contexts.ModelContext
Answers the question, has the given type been processed?
hasSeenType(ResolvedType) - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext
 
hasWildcards(ResolvedType) - Static method in class springfox.documentation.schema.WildcardType
 
Header - Class in springfox.documentation.service
 
Header(String, String, ModelReference) - Constructor for class springfox.documentation.service.Header
 
headers(Map<String, ModelReference>) - Method in class springfox.documentation.builders.ResponseMessageBuilder
headers() - Method in interface springfox.documentation.RequestHandler
 
headers() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
headers() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
headers() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
headers() - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
headers() - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
headers(ResponseHeader[]) - Static method in class springfox.documentation.swagger.readers.operation.ResponseHeaders
 
headersWithDescription(Map<String, Header>) - Method in class springfox.documentation.builders.ResponseMessageBuilder
Updates the response headers
hidden(boolean) - Method in class springfox.documentation.builders.ApiDescriptionBuilder
Marks the operation as hidden
hidden(boolean) - Method in class springfox.documentation.builders.OperationBuilder
Marks the operation as hidden
hidden(boolean) - Method in class springfox.documentation.builders.ParameterBuilder
Updates if the parameter is hidden
host(String) - Method in class springfox.documentation.builders.ApiListingBuilder
Updates the host
host(String) - Method in class springfox.documentation.builders.DocumentationBuilder
Updates the host (name or ip) serving this api.
host(String) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
host(String) - Method in class springfox.documentation.spring.web.plugins.Docket
 
HostNameProvider - Class in springfox.documentation.swagger.common
 
HostNameProvider() - Constructor for class springfox.documentation.swagger.common.HostNameProvider
 
httpMethod() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
httpStatusCode(OperationContext) - Static method in class springfox.documentation.spring.web.readers.operation.ResponseMessagesReader
 

I

id(String) - Method in class springfox.documentation.builders.ModelBuilder
Updates the Id of the model, usually the type name
Identifiable<T> - Interface in springfox.petstore.repository
 
Identifiable<T> - Interface in springfox.petstore.webflux.repository
 
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.
ImplicitGrant - Class in springfox.documentation.service
 
ImplicitGrant(LoginEndpoint, String) - Constructor for class springfox.documentation.service.ImplicitGrant
 
ImplicitGrant - Class in springfox.documentation.swagger1.dto
 
ImplicitGrant() - Constructor for class springfox.documentation.swagger1.dto.ImplicitGrant
 
ImplicitGrant(LoginEndpoint, String) - Constructor for class springfox.documentation.swagger1.dto.ImplicitGrant
 
ImplicitGrantBuilder - Class in springfox.documentation.builders
 
ImplicitGrantBuilder() - Constructor for class springfox.documentation.builders.ImplicitGrantBuilder
 
in(ResolvedType) - Method in class springfox.documentation.schema.property.bean.AccessorsProvider
 
in(ResolvedType, Predicate<ResolvedParameterizedMember>) - Method in class springfox.documentation.schema.property.FactoryMethodProvider
 
in(ResolvedType) - Method in class springfox.documentation.schema.property.field.FieldProvider
 
Incubating - Annotation Type in springfox.documentation.annotations
 
info(ApiInfo) - Method in class springfox.documentation.builders.ResourceListingBuilder
Updates the api information
initHandlerMethods() - Method in class springfox.documentation.spring.web.WebMvcPropertySourcedRequestMappingHandlerMapping
 
InMemorySwaggerResourcesProvider - Class in springfox.documentation.swagger.web
 
InMemorySwaggerResourcesProvider(Environment, DocumentationCache) - Constructor for class springfox.documentation.swagger.web.InMemorySwaggerResourcesProvider
 
inputParam(String, Type, DocumentationType, AlternateTypeProvider, GenericTypeNamingStrategy, Set<Class>) - Static method in class springfox.documentation.spi.schema.contexts.ModelContext
Convenience method to provide an new context for an input parameter
is(Version) - Method in class springfox.documentation.common.Version
Returns whether the current Version is the same as the given one.
isAllowEmptyValue() - Method in class springfox.documentation.schema.ModelProperty
Support for isAllowEmpty value
isAllowEmptyValue() - Method in class springfox.documentation.service.Parameter
 
isAllowMultiple() - Method in class springfox.documentation.service.Parameter
 
isAllowMultiple() - Method in class springfox.documentation.swagger1.dto.Parameter
 
isAnnotatedWith(Class<? extends Annotation>) - Method in interface springfox.documentation.RequestHandler
 
isAnnotatedWith(Class<? extends Annotation>) - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
isAnnotatedWith(Class<? extends Annotation>) - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
isAnnotatedWith(Class<? extends Annotation>) - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
isAutoStartup() - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
 
isBaseType(String) - Static method in class springfox.documentation.schema.Types
 
isBaseType(ResolvedType) - Static method in class springfox.documentation.schema.Types
 
isCollection() - Method in class springfox.documentation.schema.ModelRef
 
isCollection() - Method in interface springfox.documentation.schema.ModelReference
 
isComplete() - Method in class springfox.petstore.model.Order
 
isComplete() - Method in class springfox.petstore.webflux.model.Order
 
isContainerType(ResolvedType) - Static method in class springfox.documentation.schema.Collections
 
isEnabled() - Method in interface springfox.documentation.spi.service.DocumentationPlugin
 
isEnabled() - Method in class springfox.documentation.spring.web.plugins.Docket
 
isEnum(Class<?>) - Method in class springfox.documentation.schema.JacksonEnumTypeDeterminer
 
isEnum(Class<?>) - Method in interface springfox.documentation.spi.schema.EnumTypeDeterminer
 
isGreaterThan(Version) - Method in class springfox.documentation.common.Version
Returns whether the current Version is greater (newer) than the given one.
isGreaterThanOrEqualTo(Version) - Method in class springfox.documentation.common.Version
Returns whether the current Version is greater (newer) or the same as the given one.
isHandler(Class<?>) - Method in class springfox.documentation.spring.web.WebMvcPropertySourcedRequestMappingHandlerMapping
 
isHidden(Boolean) - Method in class springfox.documentation.builders.ModelPropertyBuilder
 
isHidden() - Method in class springfox.documentation.schema.ModelProperty
 
isHidden() - Method in class springfox.documentation.service.ApiDescription
 
isHidden() - Method in class springfox.documentation.service.Operation
 
isHidden() - Method in class springfox.documentation.service.Parameter
 
isHidden() - Method in class springfox.documentation.swagger1.dto.ApiDescription
 
isJsonEditor() - Method in class springfox.documentation.swagger.web.UiConfiguration
Deprecated.
@since 2.8.0
isLessThan(Version) - Method in class springfox.documentation.common.Version
Returns whether the current Version is less (older) than the given one.
isLessThanOrEqualTo(Version) - Method in class springfox.documentation.common.Version
Returns whether the current Version is less (older) or equal to the current one.
isMap() - Method in class springfox.documentation.schema.ModelRef
 
isMap() - Method in interface springfox.documentation.schema.ModelReference
 
isMapType(ResolvedType) - Static method in class springfox.documentation.schema.Maps
 
isNegated() - Method in class springfox.documentation.spring.web.WebFluxNameValueExpressionWrapper
 
isNegated() - Method in class springfox.documentation.spring.web.WebMvcNameValueExpressionWrapper
 
isNegated() - Method in interface springfox.documentation.spring.wrapper.NameValueExpression
 
isReadOnly() - Method in class springfox.documentation.schema.ModelProperty
 
isReadOnly() - Method in class springfox.documentation.schema.property.BaseModelProperty
 
isReadOnly() - Method in interface springfox.documentation.schema.property.ModelProperty
 
isRequired() - Method in class springfox.documentation.schema.ModelProperty
 
isRequired() - Method in class springfox.documentation.schema.property.BaseModelProperty
 
isRequired() - Method in interface springfox.documentation.schema.property.ModelProperty
 
isRequired() - Method in class springfox.documentation.service.Parameter
 
isRequired() - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
 
isRequired() - Method in class springfox.documentation.swagger1.dto.Parameter
 
isReturnType() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
isRunning() - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
 
isSetter(Method) - Static method in class springfox.documentation.schema.property.bean.Accessors
 
isShowRequestHeaders() - Method in class springfox.documentation.swagger.web.UiConfiguration
Deprecated.
@since 2.8.0
isUniqueItems() - Method in class springfox.documentation.swagger1.dto.ContainerDataType
 
isUriTemplatesEnabled() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
isVoid(ResolvedType) - Static method in class springfox.documentation.schema.Types
 
itemModel() - Method in class springfox.documentation.schema.ModelRef
 
itemModel() - Method in interface springfox.documentation.schema.ModelReference
 

J

JacksonEnumTypeDeterminer - Class in springfox.documentation.schema
 
JacksonEnumTypeDeterminer() - Constructor for class springfox.documentation.schema.JacksonEnumTypeDeterminer
 
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
 
JaxbPresentInClassPathCondition - Class in springfox.documentation.schema
 
JaxbPresentInClassPathCondition() - Constructor for class springfox.documentation.schema.JaxbPresentInClassPathCondition
 
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.SpringfoxWebConfiguration
 

K

key() - Method in interface springfox.documentation.RequestHandler
 
key() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
key() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
key() - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
key() - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 

L

license(String) - Method in class springfox.documentation.builders.ApiInfoBuilder
Updates license information for this API
LicenseMapper - Class in springfox.documentation.swagger2.mappers
 
LicenseMapper() - Constructor for class springfox.documentation.swagger2.mappers.LicenseMapper
 
LicenseMapper.License - Annotation Type in springfox.documentation.swagger2.mappers
 
LicenseMapper.LicenseTranslator - Annotation Type in springfox.documentation.swagger2.mappers
 
licenseUrl(String) - Method in class springfox.documentation.builders.ApiInfoBuilder
Updates the license Url for this API
listingPositionComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
listingReferencePathComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
ListVendorExtension<T> - Class in springfox.documentation.service
 
ListVendorExtension(String, List<T>) - Constructor for class springfox.documentation.service.ListVendorExtension
 
loginEndpoint(LoginEndpoint) - Method in class springfox.documentation.builders.ImplicitGrantBuilder
Updates the login endpoint
LoginEndpoint - Class in springfox.documentation.service
 
LoginEndpoint(String) - Constructor for class springfox.documentation.service.LoginEndpoint
 
LoginEndpoint - Class in springfox.documentation.swagger1.dto
 
LoginEndpoint() - Constructor for class springfox.documentation.swagger1.dto.LoginEndpoint
 
LoginEndpoint(String) - Constructor for class springfox.documentation.swagger1.dto.LoginEndpoint
 
LoginEndpointBuilder - Class in springfox.documentation.builders
 
LoginEndpointBuilder() - Constructor for class springfox.documentation.builders.LoginEndpointBuilder
 
loginUser(String, String) - Method in class springfox.petstore.controller.UserController
 
loginUser(String, String) - Method in class springfox.petstore.webflux.controller.UserController
 
logoutUser() - Method in class springfox.petstore.controller.UserController
 
logoutUser() - Method in class springfox.petstore.webflux.controller.UserController
 
lookupHandlerMethod(String, HttpServletRequest) - Method in class springfox.documentation.spring.web.WebMvcPropertySourcedRequestMappingHandlerMapping
The lookup handler method, maps the SEOMapper method to the request URL.

M

map(Contact) - Method in interface springfox.documentation.swagger1.mappers.ServiceModelToSwaggerMapper
 
map(Contact) - Method in class springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper
 
mapApiInfo(ApiInfo) - Method in class springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper
 
mapApiListings(Map<String, List<ApiListing>>) - Method in class springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper
 
mapAuthorizations(Map<String, List<AuthorizationScope>>) - Method in class springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper
 
MapBackedRepository<K,V extends Identifiable<K>> - Class in springfox.petstore.repository
 
MapBackedRepository() - Constructor for class springfox.petstore.repository.MapBackedRepository
 
MapBackedRepository<K,V extends Identifiable<K>> - Class in springfox.petstore.webflux.repository
 
MapBackedRepository() - Constructor for class springfox.petstore.webflux.repository.MapBackedRepository
 
mapDocumentation(Documentation) - Method in class springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper
 
mapExamples(List<Example>) - Method in class springfox.documentation.swagger2.mappers.ExamplesMapper
 
mapExtensions(List<VendorExtension>) - Method in class springfox.documentation.swagger2.mappers.VendorExtensionsMapper
 
mapModels(Map<String, Model>) - Method in class springfox.documentation.swagger2.mappers.ModelMapper
 
mapOperation(Operation) - Method in class springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper
 
mapParameter(Parameter) - Method in class springfox.documentation.swagger2.mappers.ParameterMapper
 
Mappers - Class in springfox.documentation.swagger1.mappers
 
Mappers() - Constructor for class springfox.documentation.swagger1.mappers.Mappers
 
mapResponseMessages(Set<ResponseMessage>) - Method in class springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper
 
Maps - Class in springfox.documentation.schema
 
mapSchemes(List<String>) - Method in class springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper
 
mapTag(Tag) - Method in class springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper
 
mapValueType(ResolvedType) - Static method in class springfox.documentation.schema.Maps
 
matches(ConditionContext, AnnotatedTypeMetadata) - Method in class springfox.documentation.schema.JaxbPresentInClassPathCondition
 
matches(ConditionContext, AnnotatedTypeMetadata) - Method in class springfox.documentation.spring.web.plugins.SpringIntegrationNotPresentInClassPathCondition
 
maxDisplayedTags(Integer) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
 
maybeAGetter(Method) - Static method in class springfox.documentation.schema.property.bean.Accessors
 
maybeASetter(Method) - Static method in class springfox.documentation.schema.property.bean.Accessors
 
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
 
maybeRegisterModule(ObjectMapper) - Method in class springfox.documentation.swagger1.configuration.SwaggerJacksonModule
 
maybeRegisterModule(ObjectMapper) - Method in class springfox.documentation.swagger2.configuration.Swagger2JacksonModule
 
MediaTypeReader - Class in springfox.documentation.spring.web.scanners
 
MediaTypeReader() - Constructor for class springfox.documentation.spring.web.scanners.MediaTypeReader
 
MediaTypes - Class in springfox.documentation.service
 
memberIsUnwrapped(AnnotatedMember) - Static method in class springfox.documentation.schema.Annotations
 
memberName(AnnotatedMember) - Static method in class springfox.documentation.schema.Annotations
 
mergedApiListing(Collection<ApiListing>) - Static method in class springfox.documentation.swagger1.web.ApiListingMerger
 
message(String) - Method in class springfox.documentation.builders.ResponseMessageBuilder
Updates the response message
message(OperationContext) - Static method in class springfox.documentation.spring.web.readers.operation.ResponseMessagesReader
 
method(HttpMethod) - Method in class springfox.documentation.builders.OperationBuilder
Updates the http method
methodComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
methodParameter() - Method in class springfox.documentation.spi.service.contexts.ParameterContext
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
 
MinMaxAnnotationPlugin - Class in springfox.bean.validators.plugins.parameter
 
MinMaxAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.parameter.MinMaxAnnotationPlugin
 
MinMaxAnnotationPlugin - Class in springfox.bean.validators.plugins.schema
 
MinMaxAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.schema.MinMaxAnnotationPlugin
 
minMaxPlugin() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
 
Model - Class in springfox.documentation.schema
 
Model(String, String, ResolvedType, String, Map<String, ModelProperty>, String, String, String, List<ModelReference>, Object, Xml) - Constructor for class springfox.documentation.schema.Model
 
model(ModelContext) - Method in class springfox.documentation.schema.plugins.SchemaPluginsManager
 
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
 
ModelBuilder - Class in springfox.documentation.builders
 
ModelBuilder() - Constructor for class springfox.documentation.builders.ModelBuilder
 
ModelBuilderPlugin - Interface in springfox.documentation.spi.schema
 
ModelContext - Class in springfox.documentation.spi.schema.contexts
 
modelContexts(RequestMappingContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 
ModelDependencyProvider - Interface in springfox.documentation.schema
 
ModelDto - Class in springfox.documentation.swagger1.dto
 
ModelDto() - Constructor for class springfox.documentation.swagger1.dto.ModelDto
 
ModelDto(String, String, String, Map<String, ModelPropertyDto>, String, String, String, List<String>) - Constructor for class springfox.documentation.swagger1.dto.ModelDto
 
modelFor(ModelContext) - Method in class springfox.documentation.schema.CachingModelProvider
 
modelFor(ModelContext) - Method in class springfox.documentation.schema.DefaultModelProvider
 
modelFor(ModelContext) - Method in interface springfox.documentation.schema.ModelProvider
 
ModelMapper - Class in springfox.documentation.swagger2.mappers
 
ModelMapper() - Constructor for class springfox.documentation.swagger2.mappers.ModelMapper
 
ModelNameContext - Class in springfox.documentation.schema
 
ModelNameContext(Class<?>, DocumentationType) - Constructor for class springfox.documentation.schema.ModelNameContext
 
ModelPropertiesProvider - Interface in springfox.documentation.schema.property
 
ModelProperty - Class in springfox.documentation.schema
 
ModelProperty(String, ResolvedType, String, int, boolean, boolean, boolean, Boolean, String, AllowableValues, Object, String, String, Xml, List<VendorExtension>) - Constructor for class springfox.documentation.schema.ModelProperty
 
ModelProperty - Interface in springfox.documentation.schema.property
 
ModelPropertyBuilder - Class in springfox.documentation.builders
 
ModelPropertyBuilder() - Constructor for class springfox.documentation.builders.ModelPropertyBuilder
 
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
 
ModelPropertyDto - Class in springfox.documentation.swagger1.dto
 
ModelPropertyDto() - Constructor for class springfox.documentation.swagger1.dto.ModelPropertyDto
 
ModelPropertyDto(String, String, String, int, Boolean, String, AllowableValues) - Constructor for class springfox.documentation.swagger1.dto.ModelPropertyDto
 
ModelProvider - Interface in springfox.documentation.schema
 
modelRef(ModelReference) - Method in class springfox.documentation.builders.ParameterBuilder
Represents the convenience method to infer the model reference Consolidate or figure out whats can be rolled into the other.
ModelRef - Class in springfox.documentation.schema
 
ModelRef(String) - Constructor for class springfox.documentation.schema.ModelRef
 
ModelRef(String, ModelReference) - Constructor for class springfox.documentation.schema.ModelRef
 
ModelRef(String, ModelReference, AllowableValues) - Constructor for class springfox.documentation.schema.ModelRef
 
ModelRef(String, AllowableValues) - Constructor for class springfox.documentation.schema.ModelRef
 
ModelRef(String, ModelReference, boolean) - Constructor for class springfox.documentation.schema.ModelRef
 
ModelRef(String, ModelReference, AllowableValues, boolean) - Constructor for class springfox.documentation.schema.ModelRef
 
ModelReference - Interface in springfox.documentation.schema
 
modelRefFactory(ModelContext, TypeNameExtractor) - Static method in class springfox.documentation.schema.ResolvedTypes
 
ModelRendering - Enum in springfox.documentation.swagger.web
 
models(Map<String, Model>) - Method in class springfox.documentation.builders.ApiListingBuilder
Adds to the models collection
ModelsConfiguration - Class in springfox.documentation.schema.configuration
 
ModelsConfiguration() - Constructor for class springfox.documentation.schema.configuration.ModelsConfiguration
 

N

name(String) - Method in class springfox.documentation.builders.DocumentationBuilder
Name of the documentation group
name(String) - Method in class springfox.documentation.builders.ModelBuilder
Updates the Name of the model
name(String) - Method in class springfox.documentation.builders.ModelPropertyBuilder
 
name(String) - Method in class springfox.documentation.builders.OAuthBuilder
Updates the unique name to identify the security definition
name(String) - Method in class springfox.documentation.builders.ParameterBuilder
Updates the parameter name
name(BeanPropertyDefinition, boolean, BeanPropertyNamingStrategy, String) - Static method in class springfox.documentation.schema.property.BeanPropertyDefinitions
 
name(String) - Method in class springfox.documentation.schema.Xml
 
name - Variable in class springfox.documentation.service.SecurityScheme
 
name - Variable in class springfox.documentation.swagger1.dto.AuthorizationType
 
nameFor(Class<?>) - Method in class springfox.documentation.schema.DefaultTypeNameProvider
 
nameFor(Class<?>) - Method in interface springfox.documentation.spi.schema.TypeNameProviderPlugin
Given a class name provides a name for it
nameFor(Class<?>) - Method in class springfox.documentation.swagger.schema.ApiModelTypeNameProvider
 
nameForDeserialization(BeanPropertyDefinition) - Method in interface springfox.documentation.schema.property.BeanPropertyNamingStrategy
 
nameForDeserialization(BeanPropertyDefinition) - Method in class springfox.documentation.schema.property.ObjectMapperBeanPropertyNamingStrategy
 
nameForSerialization(BeanPropertyDefinition) - Method in interface springfox.documentation.schema.property.BeanPropertyNamingStrategy
 
nameForSerialization(BeanPropertyDefinition) - Method in class springfox.documentation.schema.property.ObjectMapperBeanPropertyNamingStrategy
 
namespace(String) - Method in class springfox.documentation.schema.Xml
 
NameValueExpression<T> - Interface in springfox.documentation.spring.wrapper
 
newMapRule(Class<?>, Class<?>) - Static method in class springfox.documentation.schema.AlternateTypeRules
Helper method to create a new alternate for Map<K,V> that results in an alternate of type List<Entry<K,V>>.
newRule(Type, Type) - Static method in class springfox.documentation.schema.AlternateTypeRules
Helper method to create a new alternate rule.
newRule(Type, Type, int) - Static method in class springfox.documentation.schema.AlternateTypeRules
Helper method to create a new alternate rule.
nickNameComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
NO_SUBMIT_METHODS - Static variable in class springfox.documentation.swagger.web.UiConfiguration.Constants
 
none() - Static method in class springfox.documentation.builders.PathSelectors
No path satisfies this condition
none() - Static method in class springfox.documentation.builders.RequestHandlerSelectors
No RequestHandler satisfies this condition
notes(String) - Method in class springfox.documentation.builders.OperationBuilder
Updates the operation notes
notFound() - Static method in class springfox.petstore.Responses
 
notFound() - Static method in class springfox.petstore.webflux.Responses
 
NotFoundException - Exception in springfox.petstore.controller
 
NotFoundException(int, String) - Constructor for exception springfox.petstore.controller.NotFoundException
 
NotFoundException - Exception in springfox.petstore.webflux.controller
 
NotFoundException(int, String) - Constructor for exception springfox.petstore.webflux.controller.NotFoundException
 
NotNullAnnotationPlugin - Class in springfox.bean.validators.plugins.parameter
 
NotNullAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.parameter.NotNullAnnotationPlugin
 
NotNullAnnotationPlugin - Class in springfox.bean.validators.plugins.schema
 
NotNullAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.schema.NotNullAnnotationPlugin
 
notNullPlugin() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
 
nullToEmptyList(Collection<T>) - Static method in class springfox.documentation.builders.BuilderDefaults
Returns an empty list if the newValue is null
nullToEmptyMap(Map<K, V>) - Static method in class springfox.documentation.builders.BuilderDefaults
Returns an empty map if the input is null
nullToEmptyMultimap(Map<K, List<V>>) - Static method in class springfox.documentation.builders.BuilderDefaults
Returns an empty map if the input is null
nullToEmptySet(Set<T>) - Static method in class springfox.documentation.builders.BuilderDefaults
Returns an empty set if the newValue is null

O

OAuth - Class in springfox.documentation.service
 
OAuth(String, List<AuthorizationScope>, List<GrantType>, List<VendorExtension>) - Constructor for class springfox.documentation.service.OAuth
 
OAuth(String, List<AuthorizationScope>, List<GrantType>) - Constructor for class springfox.documentation.service.OAuth
 
OAuth - Class in springfox.documentation.swagger1.dto
 
OAuth() - Constructor for class springfox.documentation.swagger1.dto.OAuth
 
OAuth(List<AuthorizationScope>, List<GrantType>) - Constructor for class springfox.documentation.swagger1.dto.OAuth
 
OAuthBuilder - Class in springfox.documentation.builders
 
OAuthBuilder() - Constructor for class springfox.documentation.builders.OAuthBuilder
 
ObjectMapperBeanPropertyNamingStrategy - Class in springfox.documentation.schema.property
BeanPropertyNamingStrategy based on ObjectMapper naming strategy.
ObjectMapperBeanPropertyNamingStrategy() - Constructor for class springfox.documentation.schema.property.ObjectMapperBeanPropertyNamingStrategy
 
ObjectMapperConfigured - Class in springfox.documentation.schema.configuration
 
ObjectMapperConfigured(Object, ObjectMapper) - Constructor for class springfox.documentation.schema.configuration.ObjectMapperConfigured
Create a new ApplicationEvent.
objectMapperConfigurer() - Static method in class springfox.documentation.spring.web.SpringfoxWebFluxConfiguration
 
objectMapperConfigurer() - Static method in class springfox.documentation.spring.web.SpringfoxWebMvcConfiguration
 
ObjectVendorExtension - Class in springfox.documentation.service
 
ObjectVendorExtension(String) - Constructor for class springfox.documentation.service.ObjectVendorExtension
 
of(String) - Static method in enum springfox.documentation.swagger.web.DocExpansion
 
of(String) - Static method in enum springfox.documentation.swagger.web.ModelRendering
 
of(String) - Static method in enum springfox.documentation.swagger.web.OperationsSorter
 
of(String) - Static method in enum springfox.documentation.swagger.web.TagsSorter
 
ok() - Static method in class springfox.petstore.Responses
 
ok(T) - Static method in class springfox.petstore.Responses
 
ok() - Static method in class springfox.petstore.webflux.Responses
 
ok(T) - Static method in class springfox.petstore.webflux.Responses
 
onApplicationEvent(ObjectMapperConfigured) - Method in class springfox.documentation.schema.property.CachingModelPropertiesProvider
 
onApplicationEvent(ObjectMapperConfigured) - Method in class springfox.documentation.schema.property.ObjectMapperBeanPropertyNamingStrategy
 
onApplicationEvent(ObjectMapperConfigured) - Method in class springfox.documentation.schema.property.OptimizedModelPropertiesProvider
 
Operation - Class in springfox.documentation.service
 
Operation(HttpMethod, String, String, ModelReference, String, int, Set<String>, Set<String>, Set<String>, Set<String>, List<SecurityReference>, List<Parameter>, Set<ResponseMessage>, String, boolean, Collection<VendorExtension>) - Constructor for class springfox.documentation.service.Operation
 
operation(OperationContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 
Operation - Class in springfox.documentation.swagger1.dto
 
Operation() - Constructor for class springfox.documentation.swagger1.dto.Operation
 
Operation(String, String, String, String, String, int, List<String>, List<String>, List<String>, List<Authorization>, List<Parameter>, Set<ResponseMessage>, String) - Constructor for class springfox.documentation.swagger1.dto.Operation
 
OperationAuthReader - Class in springfox.documentation.swagger.readers.operation
 
OperationAuthReader() - Constructor for class springfox.documentation.swagger.readers.operation.OperationAuthReader
 
OperationBuilder - Class in springfox.documentation.builders
 
OperationBuilder(OperationNameGenerator) - Constructor for class springfox.documentation.builders.OperationBuilder
 
operationBuilder() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
OperationBuilderPlugin - Interface in springfox.documentation.spi.service
 
OperationCachingEquivalence - Class in springfox.documentation.spring.web
 
OperationCachingEquivalence() - Constructor for class springfox.documentation.spring.web.OperationCachingEquivalence
 
OperationCachingEquivalence.Wrapper - Class in springfox.documentation.spring.web
 
OperationContext - Class in springfox.documentation.spi.service.contexts
 
OperationContext(OperationBuilder, RequestMethod, RequestMappingContext, int) - Constructor for class springfox.documentation.spi.service.contexts.OperationContext
 
OperationDeprecatedReader - Class in springfox.documentation.spring.web.readers.operation
 
OperationDeprecatedReader() - Constructor for class springfox.documentation.spring.web.readers.operation.OperationDeprecatedReader
 
OperationHiddenReader - Class in springfox.documentation.swagger.readers.operation
 
OperationHiddenReader() - Constructor for class springfox.documentation.swagger.readers.operation.OperationHiddenReader
 
OperationHttpMethodReader - Class in springfox.documentation.swagger.readers.operation
 
OperationHttpMethodReader() - Constructor for class springfox.documentation.swagger.readers.operation.OperationHttpMethodReader
 
OperationImplicitParameterReader - Class in springfox.documentation.swagger.readers.operation
 
OperationImplicitParameterReader(DescriptionResolver) - Constructor for class springfox.documentation.swagger.readers.operation.OperationImplicitParameterReader
 
OperationImplicitParametersReader - Class in springfox.documentation.swagger.readers.operation
 
OperationImplicitParametersReader(DescriptionResolver) - Constructor for class springfox.documentation.swagger.readers.operation.OperationImplicitParametersReader
 
operationIndex() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
OperationModelContextsBuilder - Class in springfox.documentation.spi.service.contexts
 
OperationModelContextsBuilder(String, DocumentationType, AlternateTypeProvider, GenericTypeNamingStrategy, Set<Class>) - Constructor for class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder
 
operationModelsBuilder() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
OperationModelsProvider - Class in springfox.documentation.spring.web.readers.operation
 
OperationModelsProvider(TypeResolver) - Constructor for class springfox.documentation.spring.web.readers.operation.OperationModelsProvider
 
OperationModelsProviderPlugin - Interface in springfox.documentation.spi.service
 
OperationNameGenerator - Interface in springfox.documentation
 
OperationNicknameIntoUniqueIdReader - Class in springfox.documentation.swagger.readers.operation
 
OperationNicknameIntoUniqueIdReader() - Constructor for class springfox.documentation.swagger.readers.operation.OperationNicknameIntoUniqueIdReader
 
OperationNotesReader - Class in springfox.documentation.swagger.readers.operation
 
OperationNotesReader(DescriptionResolver) - Constructor for class springfox.documentation.swagger.readers.operation.OperationNotesReader
 
operationOrdering() - Method in class springfox.documentation.spi.service.contexts.Defaults
 
operationOrdering() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
 
operationOrdering(Comparator<Operation>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
operationOrdering() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
operationOrdering(Comparator<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(ModelAttributeParameterExpander, EnumTypeDeterminer) - 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
 
OperationPositionReader - Class in springfox.documentation.swagger.readers.operation
 
OperationPositionReader() - Constructor for class springfox.documentation.swagger.readers.operation.OperationPositionReader
 
OperationReader - Interface in springfox.documentation.spring.web.readers.operation
 
OperationResponseClassReader - Class in springfox.documentation.spring.web.readers.operation
 
OperationResponseClassReader(TypeNameExtractor) - Constructor for class springfox.documentation.spring.web.readers.operation.OperationResponseClassReader
 
operations(List<Operation>) - Method in class springfox.documentation.builders.ApiDescriptionBuilder
Updates the operations to the api operation
OperationsSorter - Enum in springfox.documentation.swagger.web
 
operationsSorter(OperationsSorter) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
 
OperationSummaryReader - Class in springfox.documentation.swagger.readers.operation
 
OperationSummaryReader(DescriptionResolver) - Constructor for class springfox.documentation.swagger.readers.operation.OperationSummaryReader
 
OperationTagsReader - Class in springfox.documentation.spring.web.readers.operation
 
OperationTagsReader(DefaultTagsProvider) - Constructor for class springfox.documentation.spring.web.readers.operation.OperationTagsReader
 
operationTypeFromModelRef(ModelReference) - Method in class springfox.documentation.swagger1.mappers.DataTypeMapper
 
OptimizedModelPropertiesProvider - Class in springfox.documentation.schema.property
 
OptimizedModelPropertiesProvider(AccessorsProvider, FieldProvider, FactoryMethodProvider, TypeResolver, BeanPropertyNamingStrategy, SchemaPluginsManager, TypeNameExtractor) - Constructor for class springfox.documentation.schema.property.OptimizedModelPropertiesProvider
 
OptionalDeferencer<T> - Class in springfox.documentation.spring.data.rest
 
OptionalDeferencer() - Constructor for class springfox.documentation.spring.data.rest.OptionalDeferencer
 
order(int) - Method in class springfox.documentation.builders.ParameterBuilder
Updates default order of precedence of parameters
order - Variable in class springfox.documentation.schema.AlternateTypeRule
 
Order - Class in springfox.petstore.model
 
Order() - Constructor for class springfox.petstore.model.Order
 
Order - Class in springfox.petstore.webflux.model
 
Order() - Constructor for class springfox.petstore.webflux.model.Order
 
Orderings - Class in springfox.documentation.spi.service.contexts
 
original - Variable in class springfox.documentation.schema.AlternateTypeRule
 
overTheWireName(BeanPropertyDefinition, MapperConfig<?>) - Static method in class springfox.documentation.schema.property.BeanPropertyDefinitions
 

P

pageableConvention(TypeResolver, RepositoryRestConfiguration) - Method in class springfox.documentation.spring.data.rest.configuration.SpringDataRestConfiguration
 
Parameter - Class in springfox.documentation.service
 
Parameter(String, String, String, boolean, boolean, Boolean, ModelReference, Optional<ResolvedType>, AllowableValues, String, String, boolean, String, String, int, Object, Map<String, List<Example>>, List<VendorExtension>) - Constructor for class springfox.documentation.service.Parameter
 
parameter(ParameterContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 
Parameter - Class in springfox.documentation.swagger1.dto
 
Parameter() - Constructor for class springfox.documentation.swagger1.dto.Parameter
 
Parameter(String, String, String, Boolean, Boolean, String, AllowableValues, String, String) - Constructor for class springfox.documentation.swagger1.dto.Parameter
 
parameterAccess(String) - Method in class springfox.documentation.builders.ParameterBuilder
Updates the parameter access
ParameterAnnotationReader - Class in springfox.documentation.swagger.readers.parameter
 
ParameterAnnotationReader() - Constructor for class springfox.documentation.swagger.readers.parameter.ParameterAnnotationReader
 
ParameterBuilder - Class in springfox.documentation.builders
 
ParameterBuilder() - Constructor for class springfox.documentation.builders.ParameterBuilder
 
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
 
ParameterDataTypeReader - Class in springfox.documentation.spring.web.readers.parameter
 
ParameterDataTypeReader(TypeNameExtractor, TypeResolver, EnumTypeDeterminer) - 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
 
ParameterExpansionContext - Class in springfox.documentation.spi.service.contexts
 
ParameterExpansionContext(String, String, String, ParameterMetadataAccessor, DocumentationType, ParameterBuilder) - Constructor for class springfox.documentation.spi.service.contexts.ParameterExpansionContext
 
ParameterMapper - Class in springfox.documentation.swagger2.mappers
 
ParameterMapper() - Constructor for class springfox.documentation.swagger2.mappers.ParameterMapper
 
ParameterMetadataAccessor - Interface in springfox.documentation.spi.service
 
parameterMinMax() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
 
ParameterModelProperty - Class in springfox.documentation.schema.property.bean
 
ParameterModelProperty(String, AnnotatedParameter, ResolvedParameterizedMember, TypeResolver, AlternateTypeProvider, BeanPropertyDefinition) - Constructor for class springfox.documentation.schema.property.bean.ParameterModelProperty
 
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
 
ParameterNameReader - Class in springfox.documentation.swagger1.readers.parameter
 
ParameterNameReader() - Constructor for class springfox.documentation.swagger1.readers.parameter.ParameterNameReader
 
parameterNotNull() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
 
parameterPattern() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
 
ParameterRequiredReader - Class in springfox.documentation.spring.web.readers.parameter
 
ParameterRequiredReader(DescriptionResolver) - Constructor for class springfox.documentation.spring.web.readers.parameter.ParameterRequiredReader
 
parameters(List<Parameter>) - Method in class springfox.documentation.builders.OperationBuilder
Updates the input parameters this operation needs
Parameters - Class in springfox.documentation.builders
 
parameterSize() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
 
parameterType(String) - Method in class springfox.documentation.builders.ParameterBuilder
Updates the type of parameter
ParameterTypeReader - Class in springfox.documentation.spring.web.readers.parameter
 
ParameterTypeReader() - Constructor for class springfox.documentation.spring.web.readers.parameter.ParameterTypeReader
 
paramOrReturnType(TypeResolver, ResolvedMethod) - Static method in class springfox.documentation.schema.property.bean.BeanModelProperty
 
params() - Method in interface springfox.documentation.RequestHandler
 
params() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
params() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
 
params() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
params() - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
params() - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
parse(String) - Static method in class springfox.documentation.common.Version
Parses the given string representation of a version into a Version object.
path(String) - Method in class springfox.documentation.builders.ApiDescriptionBuilder
Updates the path to the api operation
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(Function<String, String>) - Method in class springfox.documentation.builders.ApiDescriptionBuilder
 
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
 
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 - Interface in springfox.documentation
 
pathProvider(PathProvider) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
pathProvider() - Method in class springfox.documentation.spi.service.contexts.PathContext
 
pathProvider(PathProvider) - Method in class springfox.documentation.spring.web.plugins.Docket
Determines the generated, swagger specific, urls.
pathProvider() - Method in class springfox.documentation.spring.web.SpringfoxWebConfiguration
 
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
 
PathSelectors - Class in springfox.documentation.builders
 
pattern(String) - Method in class springfox.documentation.builders.ModelPropertyBuilder
 
pattern(String) - Method in class springfox.documentation.builders.ParameterBuilder
 
PatternAnnotationPlugin - Class in springfox.bean.validators.plugins.parameter
 
PatternAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.parameter.PatternAnnotationPlugin
 
PatternAnnotationPlugin - Class in springfox.bean.validators.plugins.schema
 
PatternAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.schema.PatternAnnotationPlugin
 
patternPlugin() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
 
PatternsRequestCondition<T> - Interface in springfox.documentation.spring.wrapper
 
Pet - Class in springfox.petstore.model
 
Pet() - Constructor for class springfox.petstore.model.Pet
 
Pet - Class in springfox.petstore.webflux.model
 
Pet() - Constructor for class springfox.petstore.webflux.model.Pet
 
PetController - Class in springfox.petstore.controller
 
PetController() - Constructor for class springfox.petstore.controller.PetController
 
PetController - Class in springfox.petstore.webflux.controller
 
PetController() - Constructor for class springfox.petstore.webflux.controller.PetController
 
Pets - Class in springfox.petstore.model
 
Pets() - Constructor for class springfox.petstore.model.Pets
 
Pets - Class in springfox.petstore.webflux.model
 
Pets() - Constructor for class springfox.petstore.webflux.model.Pets
 
PETSTORE_AUTH - Static variable in class springfox.petstore.webflux.controller.PetController
 
PetStoreConfiguration - Class in springfox.petstore
 
PetStoreConfiguration() - Constructor for class springfox.petstore.PetStoreConfiguration
 
PetStoreConfiguration - Class in springfox.petstore.webflux
 
PetStoreConfiguration() - Constructor for class springfox.petstore.webflux.PetStoreConfiguration
 
PetStoreResource - Class in springfox.petstore.controller
 
PetStoreResource() - Constructor for class springfox.petstore.controller.PetStoreResource
 
PetStoreResource - Class in springfox.petstore.webflux.controller
 
PetStoreResource() - Constructor for class springfox.petstore.webflux.controller.PetStoreResource
 
placeOrder(Order) - Method in class springfox.petstore.controller.PetStoreResource
 
placeOrder(Order) - Method in class springfox.petstore.webflux.controller.PetStoreResource
 
pluginDoesApply(DocumentationType) - Static method in class springfox.documentation.swagger.common.SwaggerPluginSupport
 
pluginOrdering() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
pluginsManager - Variable in class springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterExpander
 
position(int) - Method in class springfox.documentation.builders.ApiListingBuilder
Updates the position of the listing
position(int) - Method in class springfox.documentation.builders.ModelPropertyBuilder
 
position(int) - Method in class springfox.documentation.builders.OperationBuilder
Updates the index of the operation
position() - Method in class springfox.documentation.schema.property.BaseModelProperty
 
position() - Method in class springfox.documentation.schema.property.bean.ParameterModelProperty
 
position() - Method in interface springfox.documentation.schema.property.ModelProperty
 
positionComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings
 
postProcessAfterInitialization(Object, String) - Method in class springfox.documentation.spring.web.WebFluxObjectMapperConfigurer
 
postProcessAfterInitialization(Object, String) - Method in class springfox.documentation.spring.web.WebMvcObjectMapperConfigurer
 
postProcessBeforeInitialization(Object, String) - Method in class springfox.documentation.spring.web.WebFluxObjectMapperConfigurer
 
postProcessBeforeInitialization(Object, String) - Method in class springfox.documentation.spring.web.WebMvcObjectMapperConfigurer
 
prefix(String) - Method in class springfox.documentation.schema.Xml
 
PrimitiveDataType - Class in springfox.documentation.swagger1.dto
 
PrimitiveDataType(String) - Constructor for class springfox.documentation.swagger1.dto.PrimitiveDataType
 
PrimitiveFormatDataType - Class in springfox.documentation.swagger1.dto
 
PrimitiveFormatDataType(String, String) - Constructor for class springfox.documentation.swagger1.dto.PrimitiveFormatDataType
 
produces(Set<String>) - Method in class springfox.documentation.builders.ApiListingBuilder
Replaces the existing media types with new entries that this documentation produces
produces(Set<String>) - Method in class springfox.documentation.builders.DocumentationBuilder
Updates the existing media types with new entries that this documentation produces
produces(Set<String>) - Method in class springfox.documentation.builders.OperationBuilder
Updates the existing media types with new entries that this documentation produces
produces() - Method in interface springfox.documentation.RequestHandler
 
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
 
produces() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
produces(Set<String>) - Method in class springfox.documentation.spring.web.plugins.Docket
 
produces() - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
produces() - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
properties(Map<String, ModelProperty>) - Method in class springfox.documentation.builders.ModelBuilder
Updates the model properties
properties(ModelContext) - Method in interface springfox.documentation.spi.schema.SyntheticModelProviderPlugin
Creates a synthetic model properties
propertiesFor(ResolvedType, ModelContext) - Method in class springfox.documentation.schema.property.CachingModelPropertiesProvider
 
propertiesFor(ResolvedType, ModelContext) - Method in interface springfox.documentation.schema.property.ModelPropertiesProvider
 
propertiesFor(ResolvedType, ModelContext) - Method in class springfox.documentation.schema.property.OptimizedModelPropertiesProvider
 
property(AlternateTypePropertyBuilder) - Method in class springfox.documentation.builders.AlternateTypeBuilder
 
property(ModelPropertyContext) - Method in class springfox.documentation.schema.plugins.SchemaPluginsManager
 
propertyDescription() - Method in class springfox.documentation.schema.property.BaseModelProperty
 
propertyDescription() - Method in interface springfox.documentation.schema.property.ModelProperty
 
PropertyDiscriminatorBasedInheritancePlugin - Class in springfox.documentation.schema.plugins
 
PropertyDiscriminatorBasedInheritancePlugin(TypeResolver, TypeNameExtractor) - Constructor for class springfox.documentation.schema.plugins.PropertyDiscriminatorBasedInheritancePlugin
 
propertyName(Method) - Static method in class springfox.documentation.schema.property.bean.Accessors
 
PropertySourcedMapping - Annotation Type in springfox.documentation.spring.web
 
protocols(Set<String>) - Method in class springfox.documentation.builders.ApiListingBuilder
Appends to the exiting collection of supported protocols
protocols(Set<String>) - Method in class springfox.documentation.builders.OperationBuilder
Update the protocols this operation supports
protocols(Set<String>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
protocols(Set<String>) - Method in class springfox.documentation.spring.web.plugins.Docket
 

Q

qualifiedType(String) - Method in class springfox.documentation.builders.ModelBuilder
Fully package qualified name of the model
qualifiedType(String) - Method in class springfox.documentation.builders.ModelPropertyBuilder
 
qualifiedTypeName() - Method in class springfox.documentation.schema.property.BaseModelProperty
 
qualifiedTypeName() - Method in class springfox.documentation.schema.property.bean.ParameterModelProperty
 
qualifiedTypeName() - Method in interface springfox.documentation.schema.property.ModelProperty
 

R

RangeAnnotations - Class in springfox.bean.validators.plugins
 
read(OperationContext) - Method in class springfox.documentation.spring.web.plugins.SpringRestDocsOperationBuilderPlugin
Provides response messages with examples for given single operation context.
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
 
read(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.SwaggerResponseMessageReader
 
READ_PETS - Static variable in class springfox.petstore.webflux.controller.PetController
 
readOnly(Boolean) - Method in class springfox.documentation.builders.ModelPropertyBuilder
 
realm(String) - Method in class springfox.documentation.swagger.web.SecurityConfigurationBuilder
 
realType() - Method in class springfox.documentation.schema.property.BaseModelProperty
 
realType() - Method in class springfox.documentation.schema.property.bean.BeanModelProperty
 
realType() - Method in class springfox.documentation.schema.property.bean.ParameterModelProperty
 
realType() - Method in class springfox.documentation.schema.property.field.FieldModelProperty
 
RecursiveAlternateTypeRule - Class in springfox.documentation.schema
Modified solution from https://github.com/springfox/springfox/issues/2287
RecursiveAlternateTypeRule(TypeResolver, List<AlternateTypeRule>) - Constructor for class springfox.documentation.schema.RecursiveAlternateTypeRule
 
reference(String) - Method in class springfox.documentation.service.SecurityReference.SecurityReferenceBuilder
Updates the authorization reference for the api.
ReferenceDataType - Class in springfox.documentation.swagger1.dto
 
ReferenceDataType(String) - Constructor for class springfox.documentation.swagger1.dto.ReferenceDataType
 
regex(String) - Static method in class springfox.documentation.builders.PathSelectors
Predicate that evaluates the supplied regular expression
removeAdjacentForwardSlashes(String) - Static method in class springfox.documentation.spring.web.paths.Paths
 
replaceIfMoreSpecific(ResolvedType, ResolvedType) - Static method in class springfox.documentation.builders.BuilderDefaults
Coalesces the resolved type.
replaceProperty(VendorExtension) - Method in class springfox.documentation.service.ObjectVendorExtension
 
replaceResolvedParameterType(ResolvedType) - Method in class springfox.documentation.service.ResolvedMethodParameter
 
RequestHandler - Interface in springfox.documentation
 
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"
RequestHandlerExtractorConfiguration - Interface in springfox.documentation.spring.data.rest
 
RequestHandlerKey - Class in springfox.documentation
 
RequestHandlerKey(Set<String>, Set<RequestMethod>, Set<? extends MediaType>, Set<? extends MediaType>) - Constructor for class springfox.documentation.RequestHandlerKey
 
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
 
requestHandlers() - Method in class springfox.documentation.spring.data.rest.BasePathAwareServicesProvider
 
requestHandlers() - Method in class springfox.documentation.spring.web.plugins.SpringIntegrationWebFluxRequestHandlerProvider
 
requestHandlers() - Method in class springfox.documentation.spring.web.plugins.SpringIntegrationWebMvcRequestHandlerProvider
 
requestHandlers() - Method in class springfox.documentation.spring.web.plugins.WebFluxRequestHandlerProvider
 
requestHandlers() - Method in class springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider
 
RequestHandlerSelectors - Class in springfox.documentation.builders
 
RequestMappingContext - Class in springfox.documentation.spi.service.contexts
 
RequestMappingContext(DocumentationContext, RequestHandler) - Constructor for class springfox.documentation.spi.service.contexts.RequestMappingContext
 
RequestMappingInfo<T> - Interface in springfox.documentation.spring.wrapper
 
requestMappingPattern() - Method in class springfox.documentation.spi.service.contexts.OperationContext
 
required(Boolean) - Method in class springfox.documentation.builders.ModelPropertyBuilder
 
required(boolean) - Method in class springfox.documentation.builders.ParameterBuilder
Updates if the parameter is required or optional
resolve(String) - Method in class springfox.documentation.spring.web.DescriptionResolver
 
ResolvedMethodParameter - Class in springfox.documentation.service
 
ResolvedMethodParameter(String, MethodParameter, ResolvedType) - Constructor for class springfox.documentation.service.ResolvedMethodParameter
 
ResolvedMethodParameter(int, String, List<Annotation>, ResolvedType) - Constructor for class springfox.documentation.service.ResolvedMethodParameter
 
resolvedMethodParameter() - Method in class springfox.documentation.spi.service.contexts.ParameterContext
 
resolvedType(TypeResolver) - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
resolvedTypeFromOperation(TypeResolver, ResolvedType) - Static method in class springfox.documentation.swagger.annotations.Annotations
 
resolvedTypeFromResponse(TypeResolver, ResolvedType) - Static method in class springfox.documentation.swagger.annotations.Annotations
 
ResolvedTypes - Class in springfox.documentation.schema
 
resolvedTypeSignature(ResolvedType) - Static method in class springfox.documentation.schema.ResolvedTypes
 
resolver - Variable in class springfox.documentation.schema.property.BaseModelProperty
 
ResourceGroup - Class in springfox.documentation.service
 
ResourceGroup(String, Class<?>) - Constructor for class springfox.documentation.service.ResourceGroup
 
ResourceGroup(String, Class<?>, Integer) - Constructor for class springfox.documentation.service.ResourceGroup
 
resourceGroupCache() - Method in class springfox.documentation.spring.web.SpringfoxWebConfiguration
 
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
resourceGroupingStrategy(DocumentationType) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
 
resourceListing(ResourceListing) - Method in class springfox.documentation.builders.DocumentationBuilder
Updates the resource listing
ResourceListing - Class in springfox.documentation.service
 
ResourceListing(String, List<ApiListingReference>, List<SecurityScheme>, ApiInfo) - Constructor for class springfox.documentation.service.ResourceListing
 
resourceListing - Variable in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
 
ResourceListing - Class in springfox.documentation.swagger1.dto
 
ResourceListing() - Constructor for class springfox.documentation.swagger1.dto.ResourceListing
 
ResourceListing(String, String, List<ApiListingReference>, List<AuthorizationType>, ApiInfo) - Constructor for class springfox.documentation.swagger1.dto.ResourceListing
 
ResourceListingBuilder - Class in springfox.documentation.builders
 
ResourceListingBuilder() - Constructor for class springfox.documentation.builders.ResourceListingBuilder
 
ResourceOwnerPasswordCredentialsGrant - Class in springfox.documentation.service
 
ResourceOwnerPasswordCredentialsGrant(String) - Constructor for class springfox.documentation.service.ResourceOwnerPasswordCredentialsGrant
 
resourcePath(String) - Method in class springfox.documentation.builders.ApiListingBuilder
Updates resource path for the api listing
resourcePath() - Method in class springfox.documentation.spring.data.rest.EntityContext
 
resourcesModelProvider(TypeResolver, TypeNameExtractor) - Method in class springfox.documentation.spring.data.rest.schema.SpringDataRestSchemaExtensions
 
ResponseHeaders - Class in springfox.documentation.swagger.readers.operation
 
ResponseMessage - Class in springfox.documentation.service
 
ResponseMessage(int, String, ModelReference, List<Example>, Map<String, Header>, List<VendorExtension>) - Constructor for class springfox.documentation.service.ResponseMessage
 
ResponseMessage - Class in springfox.documentation.swagger1.dto
 
ResponseMessage() - Constructor for class springfox.documentation.swagger1.dto.ResponseMessage
 
ResponseMessage(int, String, String) - Constructor for class springfox.documentation.swagger1.dto.ResponseMessage
 
ResponseMessageBuilder - Class in springfox.documentation.builders
 
ResponseMessageBuilder() - Constructor for class springfox.documentation.builders.ResponseMessageBuilder
 
responseMessages(Set<ResponseMessage>) - Method in class springfox.documentation.builders.OperationBuilder
Updates the response messages
ResponseMessagesReader - Class in springfox.documentation.spring.web.readers.operation
 
ResponseMessagesReader(TypeNameExtractor) - Constructor for class springfox.documentation.spring.web.readers.operation.ResponseMessagesReader
 
responseModel(ModelReference) - Method in class springfox.documentation.builders.OperationBuilder
Updates the reference to the response model
responseModel(ModelReference) - Method in class springfox.documentation.builders.ResponseMessageBuilder
Updates the model the response represents
Responses - Class in springfox.petstore
 
Responses() - Constructor for class springfox.petstore.Responses
 
Responses - Class in springfox.petstore.webflux
 
Responses() - Constructor for class springfox.petstore.webflux.Responses
 
responseTypeName(ModelReference) - Method in class springfox.documentation.swagger1.mappers.DataTypeMapper
 
returnValue(String, Type, DocumentationType, AlternateTypeProvider, GenericTypeNamingStrategy, Set<Class>) - Static method in class springfox.documentation.spi.schema.contexts.ModelContext
Convenience method to provide an new context for an return parameter
ROOT - Static variable in class springfox.documentation.spring.web.paths.Paths
 
rootPathWhenEmpty(String) - Static method in class springfox.documentation.spring.web.paths.Paths
 
ruleBuilders(List<Function<TypeResolver, AlternateTypeRule>>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
rules() - Method in interface springfox.documentation.schema.AlternateTypeRuleConvention
 
rules(List<AlternateTypeRule>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
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.
scalarExample(Object) - Method in class springfox.documentation.builders.ParameterBuilder
 
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
 
scanned - Variable in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
 
SchemaPluginsManager - Class in springfox.documentation.schema.plugins
 
SchemaPluginsManager(PluginRegistry<ModelPropertyBuilderPlugin, DocumentationType>, PluginRegistry<ModelBuilderPlugin, DocumentationType>, PluginRegistry<SyntheticModelProviderPlugin, ModelContext>) - Constructor for class springfox.documentation.schema.plugins.SchemaPluginsManager
 
schemes(Set<String>) - Method in class springfox.documentation.builders.DocumentationBuilder
Updates the schemes this api supports
scope(String) - Method in class springfox.documentation.builders.AuthorizationScopeBuilder
Updates the scope
scopes(List<AuthorizationScope>) - Method in class springfox.documentation.builders.OAuthBuilder
Updates the authorization scopes with the new scopes
scopes(AuthorizationScope[]) - Method in class springfox.documentation.service.SecurityReference.SecurityReferenceBuilder
Updates the authorization scopes that this authorization applies to.
scopeSeparator() - Method in class springfox.documentation.swagger.web.SecurityConfiguration
 
scopeSeparator(String) - Method in class springfox.documentation.swagger.web.SecurityConfigurationBuilder
 
searchMappings() - Method in class springfox.documentation.spring.data.rest.EntityContext
 
securityConfiguration() - Method in class springfox.documentation.swagger.web.ApiResourceController
 
SecurityConfiguration - Class in springfox.documentation.swagger.web
 
SecurityConfiguration(String, String, String, String, String, ApiKeyVehicle, String, String) - Constructor for class springfox.documentation.swagger.web.SecurityConfiguration
Deprecated.
@since 2.8.0. Use the SecurityConfigurationBuilder instead
SecurityConfiguration(String, String, String, String, String, Map<String, Object>, Boolean) - Constructor for class springfox.documentation.swagger.web.SecurityConfiguration
Default constructor
SecurityConfigurationBuilder - Class in springfox.documentation.swagger.web
 
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
 
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.
securityForOperation(OperationContext) - Method in class springfox.documentation.spi.service.contexts.SecurityContext
 
securityForPath(String) - Method in class springfox.documentation.spi.service.contexts.SecurityContext
SecurityMapper - Class in springfox.documentation.swagger2.mappers
 
SecurityMapper() - Constructor for class springfox.documentation.swagger2.mappers.SecurityMapper
 
SecurityReference - Class in springfox.documentation.service
 
SecurityReference(String, AuthorizationScope[]) - Constructor for class springfox.documentation.service.SecurityReference
 
SecurityReference.SecurityReferenceBuilder - Class in springfox.documentation.service
 
securityReferences(List<SecurityReference>) - Method in class springfox.documentation.builders.ApiListingBuilder
Updates the references to the security definitions
securityReferences(List<SecurityReference>) - Method in class springfox.documentation.spi.service.contexts.SecurityContextBuilder
 
SecurityScheme - Class in springfox.documentation.service
 
SecurityScheme(String, String) - Constructor for class springfox.documentation.service.SecurityScheme
 
securitySchemes(List<? extends SecurityScheme>) - Method in class springfox.documentation.builders.ResourceListingBuilder
Updates the security definitions that protect this resource listing
securitySchemes(List<? extends SecurityScheme>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
securitySchemes(List<? extends 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.
seen(ResolvedType) - Method in class springfox.documentation.spi.schema.contexts.ModelContext
 
select() - Method in class springfox.documentation.spring.web.plugins.Docket
Initiates a builder for api selection.
selector(ApiSelector) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
SerializableParameterFactories - Class in springfox.documentation.swagger2.mappers
 
ServiceModelToSwagger2Mapper - Class in springfox.documentation.swagger2.mappers
 
ServiceModelToSwagger2Mapper() - Constructor for class springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper
 
ServiceModelToSwaggerMapper - Interface in springfox.documentation.swagger1.mappers
 
setAllowableValues(AllowableValues) - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
 
setAllowableValues(AllowableValues) - Method in class springfox.documentation.swagger1.dto.Parameter
 
setAllowMultiple(Boolean) - Method in class springfox.documentation.swagger1.dto.Parameter
 
setApis(List<ApiDescription>) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
setApis(List<ApiListingReference>) - Method in class springfox.documentation.swagger1.dto.ResourceListing
 
setApiVersion(String) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
setApiVersion(String) - Method in class springfox.documentation.swagger1.dto.ResourceListing
 
setApplicationEventPublisher(ApplicationEventPublisher) - Method in class springfox.documentation.spring.web.WebFluxObjectMapperConfigurer
 
setApplicationEventPublisher(ApplicationEventPublisher) - Method in class springfox.documentation.spring.web.WebMvcObjectMapperConfigurer
 
setAttribute(Boolean) - Method in class springfox.documentation.schema.Xml
 
setAuthorizations(List<Authorization>) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
setAuthorizations(Map<String, List<AuthorizationScope>>) - Method in class springfox.documentation.swagger1.dto.Operation
 
setAuthorizations(List<AuthorizationType>) - Method in class springfox.documentation.swagger1.dto.ResourceListing
 
setBaseModel(String) - Method in class springfox.documentation.swagger1.dto.ModelDto
 
setBasePath(String) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
setCategory(Category) - Method in class springfox.petstore.model.Pet
 
setCategory(Category) - Method in class springfox.petstore.webflux.model.Pet
 
setClientIdName(String) - Method in class springfox.documentation.swagger1.dto.TokenRequestEndpoint
 
setClientSecretName(String) - Method in class springfox.documentation.swagger1.dto.TokenRequestEndpoint
 
setCode(int) - Method in class springfox.documentation.swagger1.dto.ResponseMessage
 
setCombiner(RequestHandlerCombiner) - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
 
setCombiner(RequestHandlerCombiner) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
 
setCombiner(RequestHandlerCombiner) - Method in class springfox.documentation.spring.web.plugins.SpringIntegrationDocumentationPluginsBootstrapper
 
setComplete(boolean) - Method in class springfox.petstore.model.Order
 
setComplete(boolean) - Method in class springfox.petstore.webflux.model.Order
 
setConsumes(Set<String>) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
setConsumes(List<String>) - Method in class springfox.documentation.swagger1.dto.Operation
 
setContact(String) - Method in class springfox.documentation.swagger1.dto.ApiInfo
 
setDataType(SwaggerDataType) - Method in class springfox.documentation.swagger1.dto.Operation
 
setDefaultValue(String) - Method in class springfox.documentation.swagger1.dto.Parameter
 
setDeprecated(String) - Method in class springfox.documentation.swagger1.dto.Operation
 
setDescription(String) - Method in class springfox.documentation.swagger1.dto.ApiDescription
 
setDescription(String) - Method in class springfox.documentation.swagger1.dto.ApiInfo
 
setDescription(String) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
setDescription(String) - Method in class springfox.documentation.swagger1.dto.ApiListingReference
 
setDescription(String) - Method in class springfox.documentation.swagger1.dto.AuthorizationScope
 
setDescription(String) - Method in class springfox.documentation.swagger1.dto.ModelDto
 
setDescription(String) - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
 
setDescription(String) - Method in class springfox.documentation.swagger1.dto.Parameter
 
setDiscriminator(String) - Method in class springfox.documentation.swagger1.dto.ModelDto
 
setEmail(String) - Method in class springfox.petstore.model.User
 
setEmail(String) - Method in class springfox.petstore.webflux.model.User
 
setFirstName(String) - Method in class springfox.petstore.model.User
 
setFirstName(String) - Method in class springfox.petstore.webflux.model.User
 
setGrantTypes(List<GrantType>) - Method in class springfox.documentation.swagger1.dto.OAuth
 
setHidden(Boolean) - Method in class springfox.documentation.swagger1.dto.ApiDescription
 
setId(String) - Method in class springfox.documentation.swagger1.dto.ModelDto
 
setId(long) - Method in class springfox.petstore.model.Category
 
setId(long) - Method in class springfox.petstore.model.Order
 
setId(long) - Method in class springfox.petstore.model.Pet
 
setId(long) - Method in class springfox.petstore.model.Tag
 
setId(long) - Method in class springfox.petstore.model.User
 
setId(long) - Method in class springfox.petstore.webflux.model.Category
 
setId(long) - Method in class springfox.petstore.webflux.model.Order
 
setId(long) - Method in class springfox.petstore.webflux.model.Pet
 
setId(long) - Method in class springfox.petstore.webflux.model.Tag
 
setId(long) - Method in class springfox.petstore.webflux.model.User
 
setInfo(ApiInfo) - Method in class springfox.documentation.swagger1.dto.ResourceListing
 
setKey(V) - Method in class springfox.documentation.schema.Entry
 
setKeyname(String) - Method in class springfox.documentation.swagger1.dto.ApiKey
 
setLastName(String) - Method in class springfox.petstore.model.User
 
setLastName(String) - Method in class springfox.petstore.webflux.model.User
 
setLicense(String) - Method in class springfox.documentation.swagger1.dto.ApiInfo
 
setLicenseUrl(String) - Method in class springfox.documentation.swagger1.dto.ApiInfo
 
setLocation(String) - Method in class springfox.documentation.swagger.web.SwaggerResource
 
setLoginEndpoint(LoginEndpoint) - Method in class springfox.documentation.swagger1.dto.ImplicitGrant
 
setMax(String) - Method in class springfox.documentation.swagger1.dto.AllowableRangeValues
 
setMessage(String) - Method in class springfox.documentation.swagger1.dto.ResponseMessage
 
setMethod(String) - Method in class springfox.documentation.swagger1.dto.Operation
 
setMin(String) - Method in class springfox.documentation.swagger1.dto.AllowableRangeValues
 
setModels(Map<String, ModelDto>) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
setName(String) - Method in class springfox.documentation.schema.Xml
 
setName(String) - Method in class springfox.documentation.swagger.web.SwaggerResource
 
setName(String) - Method in class springfox.documentation.swagger1.dto.AuthorizationType
 
setName(String) - Method in class springfox.documentation.swagger1.dto.ModelDto
 
setName(String) - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
 
setName(String) - Method in class springfox.documentation.swagger1.dto.Parameter
 
setName(String) - Method in class springfox.petstore.model.Category
 
setName(String) - Method in class springfox.petstore.model.Pet
 
setName(String) - Method in class springfox.petstore.model.Tag
 
setName(String) - Method in class springfox.petstore.webflux.model.Category
 
setName(String) - Method in class springfox.petstore.webflux.model.Pet
 
setName(String) - Method in class springfox.petstore.webflux.model.Tag
 
setNamespace(String) - Method in class springfox.documentation.schema.Xml
 
setNickname(String) - Method in class springfox.documentation.swagger1.dto.Operation
 
setNotes(String) - Method in class springfox.documentation.swagger1.dto.Operation
 
setOperations(List<Operation>) - Method in class springfox.documentation.swagger1.dto.ApiDescription
 
setParamAccess(String) - Method in class springfox.documentation.swagger1.dto.Parameter
 
setParameters(List<Parameter>) - Method in class springfox.documentation.swagger1.dto.Operation
 
setParameterType(SwaggerDataType) - Method in class springfox.documentation.swagger1.dto.Parameter
 
setParamType(String) - Method in class springfox.documentation.swagger1.dto.Parameter
 
setPassAs(String) - Method in class springfox.documentation.swagger1.dto.ApiKey
 
setPassword(String) - Method in class springfox.petstore.model.User
 
setPassword(String) - Method in class springfox.petstore.webflux.model.User
 
setPath(String) - Method in class springfox.documentation.swagger1.dto.ApiDescription
 
setPath(String) - Method in class springfox.documentation.swagger1.dto.ApiListingReference
 
setPetId(long) - Method in class springfox.petstore.model.Order
 
setPetId(long) - Method in class springfox.petstore.webflux.model.Order
 
setPhone(String) - Method in class springfox.petstore.model.User
 
setPhone(String) - Method in class springfox.petstore.webflux.model.User
 
setPhotoUrls(List<String>) - Method in class springfox.petstore.model.Pet
 
setPhotoUrls(List<String>) - Method in class springfox.petstore.webflux.model.Pet
 
setPosition(int) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
setPosition(int) - Method in class springfox.documentation.swagger1.dto.ApiListingReference
 
setPosition(int) - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
 
setPosition(int) - Method in class springfox.documentation.swagger1.dto.Operation
 
setPrefix(String) - Method in class springfox.documentation.schema.Xml
 
setProduces(Set<String>) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
setProduces(List<String>) - Method in class springfox.documentation.swagger1.dto.Operation
 
setProperties(Map<String, ModelPropertyDto>) - Method in class springfox.documentation.swagger1.dto.ModelDto
 
setProtocol(List<String>) - Method in class springfox.documentation.swagger1.dto.Operation
 
setProtocols(Set<String>) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
setQualifiedType(String) - Method in class springfox.documentation.swagger1.dto.ModelDto
 
setQualifiedType(String) - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
 
setQuantity(int) - Method in class springfox.petstore.model.Order
 
setQuantity(int) - Method in class springfox.petstore.webflux.model.Order
 
setRequired(Boolean) - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
 
setRequired(Boolean) - Method in class springfox.documentation.swagger1.dto.Parameter
 
setResourcePath(String) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
setResponseMessages(Set<ResponseMessage>) - Method in class springfox.documentation.swagger1.dto.Operation
 
setResponseModel(String) - Method in class springfox.documentation.swagger1.dto.ResponseMessage
 
setScope(String) - Method in class springfox.documentation.swagger1.dto.AuthorizationScope
 
setScopes(List<AuthorizationScope>) - Method in class springfox.documentation.swagger1.dto.Authorization
 
setScopes(List<AuthorizationScope>) - Method in class springfox.documentation.swagger1.dto.OAuth
 
setShipDate(Date) - Method in class springfox.petstore.model.Order
 
setShipDate(Date) - Method in class springfox.petstore.webflux.model.Order
 
setStatus(String) - Method in class springfox.petstore.model.Order
 
setStatus(String) - Method in class springfox.petstore.model.Pet
 
setStatus(String) - Method in class springfox.petstore.webflux.model.Order
 
setStatus(String) - Method in class springfox.petstore.webflux.model.Pet
 
setSubTypes(List<String>) - Method in class springfox.documentation.swagger1.dto.ModelDto
 
setSummary(String) - Method in class springfox.documentation.swagger1.dto.Operation
 
setSwaggerVersion(String) - Method in class springfox.documentation.swagger.web.SwaggerResource
 
setSwaggerVersion(String) - Method in class springfox.documentation.swagger1.dto.ApiListing
 
setSwaggerVersion(String) - Method in class springfox.documentation.swagger1.dto.ResourceListing
 
setTags(List<Tag>) - Method in class springfox.petstore.model.Pet
 
setTags(List<Tag>) - Method in class springfox.petstore.webflux.model.Pet
 
setTermsOfServiceUrl(String) - Method in class springfox.documentation.swagger1.dto.ApiInfo
 
setTitle(String) - Method in class springfox.documentation.swagger1.dto.ApiInfo
 
setTokenEndpoint(TokenEndpoint) - Method in class springfox.documentation.swagger1.dto.AuthorizationCodeGrant
 
setTokenName(String) - Method in class springfox.documentation.swagger1.dto.ImplicitGrant
 
setTokenName(String) - Method in class springfox.documentation.swagger1.dto.TokenEndpoint
 
setTokenRequestEndpoint(TokenRequestEndpoint) - Method in class springfox.documentation.swagger1.dto.AuthorizationCodeGrant
 
setType(String) - Method in class springfox.documentation.swagger1.dto.Authorization
 
setType(String) - Method in class springfox.documentation.swagger1.dto.GrantType
 
setType(DataType) - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
 
setTypeConventions(List<AlternateTypeRuleConvention>) - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
 
setTypeConventions(List<AlternateTypeRuleConvention>) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
 
setTypeConventions(List<AlternateTypeRuleConvention>) - Method in class springfox.documentation.spring.web.plugins.SpringIntegrationDocumentationPluginsBootstrapper
 
setupModule(Module.SetupContext) - Method in class springfox.documentation.swagger1.configuration.SwaggerJacksonModule
 
setupModule(Module.SetupContext) - Method in class springfox.documentation.swagger2.configuration.Swagger2JacksonModule
 
setUrl(String) - Method in class springfox.documentation.swagger.web.SwaggerResource
 
setUrl(String) - Method in class springfox.documentation.swagger1.dto.LoginEndpoint
 
setUrl(String) - Method in class springfox.documentation.swagger1.dto.TokenEndpoint
 
setUrl(String) - Method in class springfox.documentation.swagger1.dto.TokenRequestEndpoint
 
setUsername(String) - Method in class springfox.petstore.model.User
 
setUsername(String) - Method in class springfox.petstore.webflux.model.User
 
setUserStatus(int) - Method in class springfox.petstore.model.User
 
setUserStatus(int) - Method in class springfox.petstore.webflux.model.User
 
setValues(List<String>) - Method in class springfox.documentation.swagger1.dto.AllowableListValues
 
setValueType(String) - Method in class springfox.documentation.swagger1.dto.AllowableListValues
 
setWrapped(Boolean) - Method in class springfox.documentation.schema.Xml
 
showExtensions(Boolean) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
 
simpleQualifiedTypeName(ResolvedType) - Static method in class springfox.documentation.schema.ResolvedTypes
 
SizeAnnotationPlugin - Class in springfox.bean.validators.plugins.parameter
 
SizeAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.parameter.SizeAnnotationPlugin
 
SizeAnnotationPlugin - Class in springfox.bean.validators.plugins.schema
 
SizeAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.schema.SizeAnnotationPlugin
 
sizePlugin() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
 
sortedPaths(PatternsRequestCondition) - Static method in interface springfox.documentation.RequestHandler
 
splitCamelCase(String, String) - Static method in class springfox.documentation.spring.web.paths.Paths
 
SPRING_WEB - Static variable in class springfox.documentation.spi.DocumentationType
 
SpringDataRestConfiguration - Class in springfox.documentation.spring.data.rest.configuration
 
SpringDataRestConfiguration() - Constructor for class springfox.documentation.spring.data.rest.configuration.SpringDataRestConfiguration
 
SpringDataRestSchemaExtensions - Class in springfox.documentation.spring.data.rest.schema
 
SpringDataRestSchemaExtensions() - Constructor for class springfox.documentation.spring.data.rest.schema.SpringDataRestSchemaExtensions
 
springfox.bean.validators.configuration - package springfox.bean.validators.configuration
 
springfox.bean.validators.plugins - package springfox.bean.validators.plugins
 
springfox.bean.validators.plugins.parameter - package springfox.bean.validators.plugins.parameter
 
springfox.bean.validators.plugins.schema - package springfox.bean.validators.plugins.schema
 
springfox.documentation - package springfox.documentation
 
springfox.documentation.annotations - package springfox.documentation.annotations
 
springfox.documentation.builders - package springfox.documentation.builders
 
springfox.documentation.common - package springfox.documentation.common
 
springfox.documentation.schema - package springfox.documentation.schema
 
springfox.documentation.schema.configuration - package springfox.documentation.schema.configuration
 
springfox.documentation.schema.plugins - package springfox.documentation.schema.plugins
 
springfox.documentation.schema.property - package springfox.documentation.schema.property
 
springfox.documentation.schema.property.bean - package springfox.documentation.schema.property.bean
 
springfox.documentation.schema.property.field - package springfox.documentation.schema.property.field
 
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
 
springfox.documentation.spring.data.rest - package springfox.documentation.spring.data.rest
 
springfox.documentation.spring.data.rest.configuration - package springfox.documentation.spring.data.rest.configuration
 
springfox.documentation.spring.data.rest.schema - package springfox.documentation.spring.data.rest.schema
 
springfox.documentation.spring.web - package springfox.documentation.spring.web
Adds support for Spring Integration WebMvc inbound adapters and gateways.
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
 
springfox.documentation.spring.wrapper - package springfox.documentation.spring.wrapper
 
springfox.documentation.swagger.annotations - package springfox.documentation.swagger.annotations
 
springfox.documentation.swagger.common - package springfox.documentation.swagger.common
 
springfox.documentation.swagger.configuration - package springfox.documentation.swagger.configuration
 
springfox.documentation.swagger.readers.operation - package springfox.documentation.swagger.readers.operation
 
springfox.documentation.swagger.readers.parameter - package springfox.documentation.swagger.readers.parameter
 
springfox.documentation.swagger.schema - package springfox.documentation.swagger.schema
 
springfox.documentation.swagger.web - package springfox.documentation.swagger.web
 
springfox.documentation.swagger1.annotations - package springfox.documentation.swagger1.annotations
 
springfox.documentation.swagger1.configuration - package springfox.documentation.swagger1.configuration
 
springfox.documentation.swagger1.dto - package springfox.documentation.swagger1.dto
 
springfox.documentation.swagger1.mappers - package springfox.documentation.swagger1.mappers
 
springfox.documentation.swagger1.readers.parameter - package springfox.documentation.swagger1.readers.parameter
 
springfox.documentation.swagger1.web - package springfox.documentation.swagger1.web
 
springfox.documentation.swagger2.annotations - package springfox.documentation.swagger2.annotations
 
springfox.documentation.swagger2.configuration - package springfox.documentation.swagger2.configuration
 
springfox.documentation.swagger2.mappers - package springfox.documentation.swagger2.mappers
 
springfox.documentation.swagger2.web - package springfox.documentation.swagger2.web
 
springfox.petstore - package springfox.petstore
 
springfox.petstore.controller - package springfox.petstore.controller
 
springfox.petstore.model - package springfox.petstore.model
 
springfox.petstore.repository - package springfox.petstore.repository
 
springfox.petstore.webflux - package springfox.petstore.webflux
 
springfox.petstore.webflux.controller - package springfox.petstore.webflux.controller
 
springfox.petstore.webflux.model - package springfox.petstore.webflux.model
 
springfox.petstore.webflux.repository - package springfox.petstore.webflux.repository
 
SpringfoxTemplateFormat - Class in springfox.documentation.spring.web
 
SpringfoxTemplateFormat() - Constructor for class springfox.documentation.spring.web.SpringfoxTemplateFormat
 
SpringfoxWebConfiguration - Class in springfox.documentation.spring.web
 
SpringfoxWebConfiguration() - Constructor for class springfox.documentation.spring.web.SpringfoxWebConfiguration
 
SpringfoxWebFluxConfiguration - Class in springfox.documentation.spring.web
 
SpringfoxWebFluxConfiguration() - Constructor for class springfox.documentation.spring.web.SpringfoxWebFluxConfiguration
 
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
 
SpringIntegrationDocumentationPluginsBootstrapper - Class in springfox.documentation.spring.web.plugins
After Spring ContextRefreshedEvent, builds and executes all DocumentationConfigurer instances found in the application context, because only after ContextRefreshedEvent the spring-integration handler mappings are initialized.
SpringIntegrationDocumentationPluginsBootstrapper(DocumentationPluginsManager, List<RequestHandlerProvider>, DocumentationCache, ApiDocumentationScanner, TypeResolver, Defaults, PathProvider) - Constructor for class springfox.documentation.spring.web.plugins.SpringIntegrationDocumentationPluginsBootstrapper
 
SpringIntegrationNotPresentInClassPathCondition - Class in springfox.documentation.spring.web.plugins
 
SpringIntegrationNotPresentInClassPathCondition() - Constructor for class springfox.documentation.spring.web.plugins.SpringIntegrationNotPresentInClassPathCondition
 
SpringIntegrationParametersProvider - Class in springfox.documentation.spring.web.plugins
Provides information about Spring Integration inbound HTTP handlers.
SpringIntegrationParametersProvider() - Constructor for class springfox.documentation.spring.web.plugins.SpringIntegrationParametersProvider
 
SpringIntegrationWebFluxRequestHandler - Class in springfox.documentation.spring.web
Provides information about WebFlux based Spring Integration inbound HTTP handlers.
SpringIntegrationWebFluxRequestHandler(HandlerMethodResolver, RequestMappingInfo, HandlerMethod, SpringIntegrationParametersProvider) - Constructor for class springfox.documentation.spring.web.SpringIntegrationWebFluxRequestHandler
 
SpringIntegrationWebFluxRequestHandlerProvider - Class in springfox.documentation.spring.web.plugins
 
SpringIntegrationWebFluxRequestHandlerProvider(HandlerMethodResolver, List<WebFluxIntegrationRequestMappingHandlerMapping>, SpringIntegrationParametersProvider) - Constructor for class springfox.documentation.spring.web.plugins.SpringIntegrationWebFluxRequestHandlerProvider
 
SpringIntegrationWebMvcRequestHandler - Class in springfox.documentation.spring.web
Provides information about WebMvc based Spring Integration inbound HTTP handlers.
SpringIntegrationWebMvcRequestHandler(String, HandlerMethodResolver, RequestMappingInfo, HandlerMethod, SpringIntegrationParametersProvider) - Constructor for class springfox.documentation.spring.web.SpringIntegrationWebMvcRequestHandler
 
SpringIntegrationWebMvcRequestHandlerProvider - Class in springfox.documentation.spring.web.plugins
 
SpringIntegrationWebMvcRequestHandlerProvider(Optional<ServletContext>, HandlerMethodResolver, List<IntegrationRequestMappingHandlerMapping>, SpringIntegrationParametersProvider) - Constructor for class springfox.documentation.spring.web.plugins.SpringIntegrationWebMvcRequestHandlerProvider
 
SpringRestDocsOperationBuilderPlugin - Class in springfox.documentation.spring.web.plugins
 
SpringRestDocsOperationBuilderPlugin() - Constructor for class springfox.documentation.spring.web.plugins.SpringRestDocsOperationBuilderPlugin
 
SpringVersion - Class in springfox.documentation.common
Class providing a proxy for @SpringVersion This enable mocking and testing of specific situations
SpringVersion() - Constructor for class springfox.documentation.common.SpringVersion
 
SpringVersionCapability - Class in springfox.documentation.common
 
SpringVersionCapability() - Constructor for class springfox.documentation.common.SpringVersionCapability
 
start() - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
 
startingWith(String) - Method in interface springfox.documentation.OperationNameGenerator
 
startingWith(String) - Method in class springfox.documentation.spring.web.readers.operation.CachingOperationNameGenerator
 
statusIs(String) - Static method in class springfox.petstore.model.Pets
 
statusIs(String) - Static method in class springfox.petstore.webflux.model.Pets
 
stop(Runnable) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
 
stop() - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
 
stringLengthRange(Size) - Static method in class springfox.bean.validators.plugins.RangeAnnotations
 
StringVendorExtension - Class in springfox.documentation.service
 
StringVendorExtension(String, String) - Constructor for class springfox.documentation.service.StringVendorExtension
 
stripSlashes(String) - Static method in class springfox.documentation.spring.web.paths.Paths
 
subTypes(List<ModelReference>) - Method in class springfox.documentation.builders.ModelBuilder
Updates the subclasses for this model.
summary(String) - Method in class springfox.documentation.builders.OperationBuilder
Updates the operation summary
supportedMethods() - Method in interface springfox.documentation.RequestHandler
 
supportedMethods() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
supportedMethods() - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
supportedMethods() - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
supportedSubmitMethods(String[]) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
 
supports(DocumentationType) - Method in class springfox.bean.validators.plugins.parameter.ExpandedParameterMinMaxAnnotationPlugin
 
supports(DocumentationType) - Method in class springfox.bean.validators.plugins.parameter.ExpandedParameterNotNullAnnotationPlugin
 
supports(DocumentationType) - Method in class springfox.bean.validators.plugins.parameter.ExpandedParameterPatternAnnotationPlugin
 
supports(DocumentationType) - Method in class springfox.bean.validators.plugins.parameter.ExpandedParameterSizeAnnotationPlugin
 
supports(DocumentationType) - Method in class springfox.bean.validators.plugins.parameter.MinMaxAnnotationPlugin
 
supports(DocumentationType) - Method in class springfox.bean.validators.plugins.parameter.NotNullAnnotationPlugin
 
supports(DocumentationType) - Method in class springfox.bean.validators.plugins.parameter.PatternAnnotationPlugin
 
supports(DocumentationType) - Method in class springfox.bean.validators.plugins.parameter.SizeAnnotationPlugin
 
supports(DocumentationType) - Method in class springfox.bean.validators.plugins.schema.DecimalMinMaxAnnotationPlugin
 
supports(DocumentationType) - Method in class springfox.bean.validators.plugins.schema.MinMaxAnnotationPlugin
 
supports(DocumentationType) - Method in class springfox.bean.validators.plugins.schema.NotNullAnnotationPlugin
support all documentationTypes
supports(DocumentationType) - Method in class springfox.bean.validators.plugins.schema.PatternAnnotationPlugin
 
supports(DocumentationType) - Method in class springfox.bean.validators.plugins.schema.SizeAnnotationPlugin
 
supports(DocumentationType) - Method in class springfox.documentation.schema.DefaultTypeNameProvider
 
supports(DocumentationType) - Method in class springfox.documentation.schema.plugins.PropertyDiscriminatorBasedInheritancePlugin
 
supports(DocumentationType) - Method in class springfox.documentation.schema.plugins.XmlModelPlugin
 
supports(DocumentationType) - Method in class springfox.documentation.schema.property.XmlPropertyPlugin
 
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.plugins.SpringRestDocsOperationBuilderPlugin
 
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
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.operation.OperationAuthReader
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.operation.OperationHiddenReader
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.operation.OperationHttpMethodReader
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.operation.OperationImplicitParameterReader
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.operation.OperationImplicitParametersReader
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.operation.OperationNicknameIntoUniqueIdReader
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.operation.OperationNotesReader
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.operation.OperationPositionReader
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.operation.OperationSummaryReader
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.operation.SwaggerMediaTypeReader
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.operation.SwaggerOperationModelsProvider
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.operation.SwaggerOperationResponseClassReader
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.operation.SwaggerOperationTagsReader
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.operation.SwaggerResponseMessageReader
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.operation.VendorExtensionsReader
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.parameter.ApiParamParameterBuilder
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.readers.parameter.SwaggerExpandedParameterBuilder
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.schema.ApiModelBuilder
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.schema.ApiModelPropertyPropertyBuilder
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.schema.ApiModelTypeNameProvider
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.web.ClassOrApiAnnotationResourceGrouping
Deprecated.
 
supports(DocumentationType) - Method in class springfox.documentation.swagger.web.SwaggerApiListingReader
 
supports(DocumentationType) - Method in class springfox.documentation.swagger1.readers.parameter.ParameterNameReader
 
supports(DocumentationType) - Method in class springfox.documentation.swagger1.web.SwaggerDefaultConfiguration
 
supportsExtendedPathVariableAnnotation(Version) - Static method in class springfox.documentation.common.SpringVersionCapability
 
supportsXForwardPrefixHeader(Version) - Static method in class springfox.documentation.common.SpringVersionCapability
 
Swagger1Controller - Class in springfox.documentation.swagger1.web
 
Swagger1Controller(DocumentationCache, ServiceModelToSwaggerMapper, JsonSerializer) - Constructor for class springfox.documentation.swagger1.web.Swagger1Controller
 
swagger1ControllerMapping(Environment, DocumentationCache, ServiceModelToSwaggerMapper, JsonSerializer) - Method in class springfox.documentation.swagger1.configuration.Swagger1DocumentationConfiguration
 
Swagger1DocumentationConfiguration - Class in springfox.documentation.swagger1.configuration
 
Swagger1DocumentationConfiguration() - Constructor for class springfox.documentation.swagger1.configuration.Swagger1DocumentationConfiguration
 
swagger1Module() - Method in class springfox.documentation.swagger1.configuration.Swagger1DocumentationConfiguration
 
swagger2ControllerMapping(Environment, DocumentationCache, ServiceModelToSwagger2Mapper, JsonSerializer) - Method in class springfox.documentation.swagger2.configuration.Swagger2DocumentationWebMvcConfiguration
 
Swagger2ControllerWebFlux - Class in springfox.documentation.swagger2.web
 
Swagger2ControllerWebFlux(DocumentationCache, ServiceModelToSwagger2Mapper, JsonSerializer) - Constructor for class springfox.documentation.swagger2.web.Swagger2ControllerWebFlux
 
Swagger2ControllerWebMvc - Class in springfox.documentation.swagger2.web
 
Swagger2ControllerWebMvc(Environment, DocumentationCache, ServiceModelToSwagger2Mapper, JsonSerializer) - Constructor for class springfox.documentation.swagger2.web.Swagger2ControllerWebMvc
 
Swagger2DocumentationWebFluxConfiguration - Class in springfox.documentation.swagger2.configuration
 
Swagger2DocumentationWebFluxConfiguration() - Constructor for class springfox.documentation.swagger2.configuration.Swagger2DocumentationWebFluxConfiguration
 
Swagger2DocumentationWebMvcConfiguration - Class in springfox.documentation.swagger2.configuration
 
Swagger2DocumentationWebMvcConfiguration() - Constructor for class springfox.documentation.swagger2.configuration.Swagger2DocumentationWebMvcConfiguration
 
Swagger2JacksonModule - Class in springfox.documentation.swagger2.configuration
 
Swagger2JacksonModule() - Constructor for class springfox.documentation.swagger2.configuration.Swagger2JacksonModule
 
swagger2Module() - Method in class springfox.documentation.swagger2.configuration.Swagger2DocumentationWebFluxConfiguration
 
swagger2Module() - Method in class springfox.documentation.swagger2.configuration.Swagger2DocumentationWebMvcConfiguration
 
SWAGGER_12 - Static variable in class springfox.documentation.spi.DocumentationType
 
SWAGGER_2 - Static variable in class springfox.documentation.spi.DocumentationType
 
SWAGGER_PLUGIN_ORDER - Static variable in class springfox.documentation.swagger.common.SwaggerPluginSupport
 
SwaggerApiListingReader - Class in springfox.documentation.swagger.web
 
SwaggerApiListingReader() - Constructor for class springfox.documentation.swagger.web.SwaggerApiListingReader
 
SwaggerCommonConfiguration - Class in springfox.documentation.swagger.configuration
 
SwaggerCommonConfiguration() - Constructor for class springfox.documentation.swagger.configuration.SwaggerCommonConfiguration
 
SwaggerDataType - Interface in springfox.documentation.swagger1.dto
 
SwaggerDefaultConfiguration - Class in springfox.documentation.swagger1.web
 
SwaggerDefaultConfiguration(Defaults, TypeResolver, PathProvider) - Constructor for class springfox.documentation.swagger1.web.SwaggerDefaultConfiguration
 
swaggerDefaults(PathProvider, TypeResolver, Defaults) - Method in class springfox.documentation.swagger1.configuration.Swagger1DocumentationConfiguration
 
SwaggerExpandedParameterBuilder - Class in springfox.documentation.swagger.readers.parameter
 
SwaggerExpandedParameterBuilder(DescriptionResolver, EnumTypeDeterminer) - Constructor for class springfox.documentation.swagger.readers.parameter.SwaggerExpandedParameterBuilder
 
SwaggerJacksonModule - Class in springfox.documentation.swagger1.configuration
 
SwaggerJacksonModule() - Constructor for class springfox.documentation.swagger1.configuration.SwaggerJacksonModule
 
SwaggerMediaTypeReader - Class in springfox.documentation.swagger.readers.operation
 
SwaggerMediaTypeReader() - Constructor for class springfox.documentation.swagger.readers.operation.SwaggerMediaTypeReader
 
SwaggerOperationModelsProvider - Class in springfox.documentation.swagger.readers.operation
 
SwaggerOperationModelsProvider(TypeResolver) - Constructor for class springfox.documentation.swagger.readers.operation.SwaggerOperationModelsProvider
 
SwaggerOperationResponseClassReader - Class in springfox.documentation.swagger.readers.operation
 
SwaggerOperationResponseClassReader(TypeResolver, TypeNameExtractor) - Constructor for class springfox.documentation.swagger.readers.operation.SwaggerOperationResponseClassReader
 
SwaggerOperationTagsReader - Class in springfox.documentation.swagger.readers.operation
 
SwaggerOperationTagsReader(DefaultTagsProvider) - Constructor for class springfox.documentation.swagger.readers.operation.SwaggerOperationTagsReader
 
SwaggerPluginSupport - Class in springfox.documentation.swagger.common
 
SwaggerResource - Class in springfox.documentation.swagger.web
 
SwaggerResource() - Constructor for class springfox.documentation.swagger.web.SwaggerResource
 
swaggerResources() - Method in class springfox.documentation.swagger.web.ApiResourceController
 
SwaggerResourcesProvider - Interface in springfox.documentation.swagger.web
 
SwaggerResponseMessageReader - Class in springfox.documentation.swagger.readers.operation
 
SwaggerResponseMessageReader(TypeNameExtractor, TypeResolver) - Constructor for class springfox.documentation.swagger.readers.operation.SwaggerResponseMessageReader
 
syntheticModel(ModelContext) - Method in class springfox.documentation.schema.plugins.SchemaPluginsManager
 
SyntheticModelProviderPlugin - Interface in springfox.documentation.spi.schema
Plugin to generate custom models
syntheticProperties(ModelContext) - Method in class springfox.documentation.schema.plugins.SchemaPluginsManager
 

T

Tag - Class in springfox.documentation.service
 
Tag(String, String) - Constructor for class springfox.documentation.service.Tag
 
Tag(String, String, int) - Constructor for class springfox.documentation.service.Tag
 
Tag(String, String, List<VendorExtension>) - Constructor for class springfox.documentation.service.Tag
 
Tag(String, String, int, List<VendorExtension>) - Constructor for class springfox.documentation.service.Tag
 
Tag - Class in springfox.petstore.model
 
Tag() - Constructor for class springfox.petstore.model.Tag
 
Tag - Class in springfox.petstore.webflux.model
 
Tag() - Constructor for class springfox.petstore.webflux.model.Tag
 
tagComparator() - Static method in class springfox.documentation.service.Tags
 
tagNames(Set<String>) - Method in class springfox.documentation.builders.ApiListingBuilder
Updates the tags
tags(Set<Tag>) - Method in class springfox.documentation.builders.ApiListingBuilder
Updates the tags.
tags(Set<Tag>) - Method in class springfox.documentation.builders.DocumentationBuilder
Updates the tags with new entries
tags(Set<String>) - Method in class springfox.documentation.builders.OperationBuilder
Updates the tags that identify this operation
Tags - Class in springfox.documentation.service
 
tags(Set<Tag>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
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
 
tagsContain(String) - Static method in class springfox.petstore.model.Pets
 
tagsContain(String) - Static method in class springfox.petstore.webflux.model.Pets
 
TagsSorter - Enum in springfox.documentation.swagger.web
 
tagsSorter(TagsSorter) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
 
termsOfServiceUrl(String) - Method in class springfox.documentation.builders.ApiInfoBuilder
Updates the terms of service url
test(RequestMappingContext, RequestMappingContext) - Method in class springfox.documentation.spring.web.OperationCachingEquivalence
 
title(String) - Method in class springfox.documentation.builders.ApiInfoBuilder
Updates the api title
toApiListingDto(HttpServletRequest, String, ServiceModelToSwaggerMapper) - Static method in class springfox.documentation.swagger1.mappers.Mappers
 
toCamelCase(String) - Static method in class springfox.documentation.schema.property.bean.Accessors
 
toJson(Object) - Method in class springfox.documentation.spring.web.json.JsonSerializer
 
tokenEndpoint(TokenEndpoint) - Method in class springfox.documentation.builders.AuthorizationCodeGrantBuilder
Updates token endpoint
TokenEndpoint - Class in springfox.documentation.service
 
TokenEndpoint(String, String) - Constructor for class springfox.documentation.service.TokenEndpoint
 
TokenEndpoint - Class in springfox.documentation.swagger1.dto
 
TokenEndpoint() - Constructor for class springfox.documentation.swagger1.dto.TokenEndpoint
 
TokenEndpoint(String, String) - Constructor for class springfox.documentation.swagger1.dto.TokenEndpoint
 
TokenEndpointBuilder - Class in springfox.documentation.builders
 
TokenEndpointBuilder() - Constructor for class springfox.documentation.builders.TokenEndpointBuilder
 
tokenName(String) - Method in class springfox.documentation.builders.ImplicitGrantBuilder
Updates the token name
tokenName(String) - Method in class springfox.documentation.builders.TokenEndpointBuilder
Updates the token name
tokenRequestEndpoint(TokenRequestEndpoint) - Method in class springfox.documentation.builders.AuthorizationCodeGrantBuilder
Updates token request endpoint
TokenRequestEndpoint - Class in springfox.documentation.service
 
TokenRequestEndpoint(String, String, String) - Constructor for class springfox.documentation.service.TokenRequestEndpoint
 
TokenRequestEndpoint - Class in springfox.documentation.swagger1.dto
 
TokenRequestEndpoint() - Constructor for class springfox.documentation.swagger1.dto.TokenRequestEndpoint
 
TokenRequestEndpoint(String, String, String) - Constructor for class springfox.documentation.swagger1.dto.TokenRequestEndpoint
 
TokenRequestEndpointBuilder - Class in springfox.documentation.builders
 
TokenRequestEndpointBuilder() - Constructor for class springfox.documentation.builders.TokenRequestEndpointBuilder
 
toMediaTypes(Set<String>) - Static method in class springfox.documentation.service.MediaTypes
 
toParameterName() - Static method in class springfox.documentation.builders.Parameters
 
toSecuritySchemeDefinitions(ResourceListing) - Method in class springfox.documentation.swagger2.mappers.SecurityMapper
 
toString() - Method in class springfox.documentation.common.Version
 
toString() - Method in class springfox.documentation.RequestHandlerKey
 
toString() - Method in class springfox.documentation.schema.Example
 
toString() - Method in class springfox.documentation.service.Header
 
toString() - Method in class springfox.documentation.service.ObjectVendorExtension
 
toString() - Method in class springfox.documentation.service.Parameter
 
toString() - Method in class springfox.documentation.service.ResourceGroup
 
toString() - Method in class springfox.documentation.service.StringVendorExtension
 
toString() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
 
toString() - Method in class springfox.documentation.spring.web.WebFluxPatternsRequestConditionWrapper
 
toString() - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
 
toString() - Method in class springfox.documentation.spring.web.WebMvcPatternsRequestConditionWrapper
 
toString() - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
 
toSwaggerAllowableListValues(AllowableListValues) - Method in class springfox.documentation.swagger1.mappers.AllowableValuesMapper
 
toSwaggerAllowableRangeValues(AllowableRangeValues) - Method in class springfox.documentation.swagger1.mappers.AllowableValuesMapper
 
toSwaggerAllowableValues(AllowableValues) - Method in class springfox.documentation.swagger1.mappers.AllowableValuesMapper
 
toSwaggerApiDescription(ApiDescription) - Method in interface springfox.documentation.swagger1.mappers.ServiceModelToSwaggerMapper
 
toSwaggerApiInfo(ApiInfo) - Method in interface springfox.documentation.swagger1.mappers.ServiceModelToSwaggerMapper
 
toSwaggerApiKey(ApiKey) - Method in class springfox.documentation.swagger1.mappers.AuthorizationTypesMapper
 
toSwaggerApiListing(ApiListing) - Method in interface springfox.documentation.swagger1.mappers.ServiceModelToSwaggerMapper
 
toSwaggerApiListingReference(ApiListingReference) - Method in interface springfox.documentation.swagger1.mappers.ServiceModelToSwaggerMapper
 
toSwaggerAuthorizationCodeGrant(AuthorizationCodeGrant) - Method in class springfox.documentation.swagger1.mappers.AuthorizationTypesMapper
 
toSwaggerAuthorizationScope(AuthorizationScope) - Method in class springfox.documentation.swagger1.mappers.AuthorizationTypesMapper
 
toSwaggerAuthorizationScopes(List<AuthorizationScope>) - Method in class springfox.documentation.swagger1.mappers.AuthorizationTypesMapper
 
toSwaggerAuthorizationType(SecurityScheme) - Method in class springfox.documentation.swagger1.mappers.AuthorizationTypesMapper
 
toSwaggerAuthorizationTypes(List<SecurityScheme>) - Method in class springfox.documentation.swagger1.mappers.AuthorizationTypesMapper
 
toSwaggerBasicAuth(BasicAuth) - Method in class springfox.documentation.swagger1.mappers.AuthorizationTypesMapper
 
toSwaggerGrantType(GrantType) - Method in class springfox.documentation.swagger1.mappers.AuthorizationTypesMapper
 
toSwaggerGrantTypes(List<GrantType>) - Method in class springfox.documentation.swagger1.mappers.AuthorizationTypesMapper
 
toSwaggerImplicitGrant(ImplicitGrant) - Method in class springfox.documentation.swagger1.mappers.AuthorizationTypesMapper
 
toSwaggerLoginEndpoint(LoginEndpoint) - Method in class springfox.documentation.swagger1.mappers.AuthorizationTypesMapper
 
toSwaggerModelDto(Model) - Method in interface springfox.documentation.swagger1.mappers.ServiceModelToSwaggerMapper
 
toSwaggerModelPropertyDto(ModelProperty) - Method in interface springfox.documentation.swagger1.mappers.ServiceModelToSwaggerMapper
 
toSwaggerOAuth(OAuth) - Method in class springfox.documentation.swagger1.mappers.AuthorizationTypesMapper
 
toSwaggerOperation(Operation) - Method in interface springfox.documentation.swagger1.mappers.ServiceModelToSwaggerMapper
 
toSwaggerParameter(Parameter) - Method in interface springfox.documentation.swagger1.mappers.ServiceModelToSwaggerMapper
 
toSwaggerResourceListing(ResourceListing) - Method in interface springfox.documentation.swagger1.mappers.ServiceModelToSwaggerMapper
 
toSwaggerResponseMessage(ResponseMessage) - Method in interface springfox.documentation.swagger1.mappers.ServiceModelToSwaggerMapper
 
toSwaggerSecurityReference(SecurityReference) - Method in class springfox.documentation.swagger1.mappers.AuthorizationTypesMapper
 
toSwaggerTokenEndpoint(TokenEndpoint) - Method in class springfox.documentation.swagger1.mappers.AuthorizationTypesMapper
 
toSwaggerTokenRequestEndpoint(TokenRequestEndpoint) - Method in class springfox.documentation.swagger1.mappers.AuthorizationTypesMapper
 
toTag(Function<String, String>) - Static method in class springfox.documentation.service.Tags
 
toTags(Map<String, List<ApiListing>>) - Static method in class springfox.documentation.service.Tags
 
type(ResolvedType) - Method in class springfox.documentation.builders.ModelBuilder
Represents the type information with full fidelity of generics
type(ResolvedType) - Method in class springfox.documentation.builders.ModelPropertyBuilder
 
type(ResolvedType) - Method in class springfox.documentation.builders.ParameterBuilder
Updates the type of parameter
type - Variable in class springfox.documentation.service.SecurityScheme
 
type - Variable in class springfox.documentation.swagger1.dto.AuthorizationType
 
typeFromDataType(String) - Method in class springfox.documentation.swagger1.dto.DataType
 
typeFromModelRef(ModelReference) - Method in class springfox.documentation.swagger1.mappers.DataTypeMapper
 
typeName(ModelContext) - Method in class springfox.documentation.schema.TypeNameExtractor
 
TypeNameExtractor - Class in springfox.documentation.schema
 
TypeNameExtractor(TypeResolver, PluginRegistry<TypeNameProviderPlugin, DocumentationType>, EnumTypeDeterminer) - Constructor for class springfox.documentation.schema.TypeNameExtractor
 
typeNameFor(Type) - Static method in class springfox.documentation.schema.Types
 
TypeNameProviderPlugin - Interface in springfox.documentation.spi.schema
 
typeResolver() - Method in class springfox.documentation.schema.configuration.ModelsConfiguration
 
typeResolver(TypeResolver) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
 
Types - Class in springfox.documentation.schema
 

U

uiConfiguration() - Method in class springfox.documentation.swagger.web.ApiResourceController
 
UiConfiguration - Class in springfox.documentation.swagger.web
 
UiConfiguration(String) - Constructor for class springfox.documentation.swagger.web.UiConfiguration
Deprecated.
@since 2.8.0. Use the UiConfigurationBuilder instead
UiConfiguration(String, String[]) - Constructor for class springfox.documentation.swagger.web.UiConfiguration
Deprecated.
@since 2.8.0. Use the UiConfigurationBuilder instead
UiConfiguration(String, String, String, String, String[], boolean, boolean) - Constructor for class springfox.documentation.swagger.web.UiConfiguration
Deprecated.
@since 2.6.1. Use the UiConfigurationBuilder instead
UiConfiguration(String, String, String, String, String[], boolean, boolean, Long) - Constructor for class springfox.documentation.swagger.web.UiConfiguration
Deprecated.
@since 2.8.0. Use the UiConfigurationBuilder instead
UiConfiguration(Boolean, Boolean, Integer, Integer, ModelRendering, Boolean, DocExpansion, Object, Integer, OperationsSorter, Boolean, TagsSorter, String) - Constructor for class springfox.documentation.swagger.web.UiConfiguration
Default constructor
UiConfiguration(Boolean, Boolean, Integer, Integer, ModelRendering, Boolean, DocExpansion, Object, Integer, OperationsSorter, Boolean, TagsSorter, String[], String) - Constructor for class springfox.documentation.swagger.web.UiConfiguration
Default constructor
UiConfiguration.Constants - Class in springfox.documentation.swagger.web
 
UiConfigurationBuilder - Class in springfox.documentation.swagger.web
 
uniqueId(String) - Method in class springfox.documentation.builders.OperationBuilder
Updates the uniqueId for the operation.
unwrappedPrefix(AnnotatedMember) - Static method in class springfox.documentation.schema.Annotations
 
updateModelRef(Function<ResolvedType, ? extends ModelReference>) - Method in class springfox.documentation.schema.ModelProperty
 
updatePet(Pet) - Method in class springfox.petstore.controller.PetController
 
updatePet(Pet) - Method in class springfox.petstore.webflux.controller.PetController
 
updateUser(String, User) - Method in class springfox.petstore.controller.UserController
 
updateUser(String, User) - Method in class springfox.petstore.webflux.controller.UserController
 
url(String) - Method in class springfox.documentation.builders.LoginEndpointBuilder
Updates the url for the login endpoint
url(String) - Method in class springfox.documentation.builders.TokenEndpointBuilder
Updates the token endpoint url
url(String) - Method in class springfox.documentation.builders.TokenRequestEndpointBuilder
Updates the url for the token request endpoint
useBasicAuthenticationWithAccessCodeGrant(Boolean) - Method in class springfox.documentation.swagger.web.SecurityConfigurationBuilder
 
useDefaultResponseMessages(boolean) - Method in class springfox.documentation.spring.web.plugins.Docket
Allows ignoring predefined response message defaults
User - Class in springfox.petstore.model
 
User() - Constructor for class springfox.petstore.model.User
 
User - Class in springfox.petstore.webflux.model
 
User() - Constructor for class springfox.petstore.webflux.model.User
 
USER_NOT_FOUND - Static variable in class springfox.petstore.webflux.controller.UserController
 
UserController - Class in springfox.petstore.controller
 
UserController() - Constructor for class springfox.petstore.controller.UserController
 
UserController - Class in springfox.petstore.webflux.controller
 
UserController() - Constructor for class springfox.petstore.webflux.controller.UserController
 
USERNAME - Static variable in class springfox.petstore.webflux.controller.UserController
 
UserRepository - Class in springfox.petstore.repository
 
UserRepository() - Constructor for class springfox.petstore.repository.UserRepository
 
UserRepository - Class in springfox.petstore.webflux.repository
 
UserRepository() - Constructor for class springfox.petstore.webflux.repository.UserRepository
 
useType(Class) - Static method in class springfox.documentation.spring.web.readers.operation.HandlerMethodResolver
 

V

Validators - Class in springfox.bean.validators.plugins
Utility methods for Validators
validatorUrl(String) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
 
value() - Method in class springfox.documentation.spring.web.json.Json
 
valueOf(String) - Static method in enum springfox.documentation.swagger.web.ApiKeyVehicle
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum springfox.documentation.swagger.web.DocExpansion
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum springfox.documentation.swagger.web.ModelRendering
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum springfox.documentation.swagger.web.OperationsSorter
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum springfox.documentation.swagger.web.TagsSorter
Returns the enum constant of this type with the specified name.
values() - Static method in enum springfox.documentation.swagger.web.ApiKeyVehicle
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum springfox.documentation.swagger.web.DocExpansion
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum springfox.documentation.swagger.web.ModelRendering
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum springfox.documentation.swagger.web.OperationsSorter
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum springfox.documentation.swagger.web.TagsSorter
Returns an array containing the constants of this enum type, in the order they are declared.
VendorExtension<T> - Interface in springfox.documentation.service
 
vendorExtensions(List<VendorExtension>) - Method in class springfox.documentation.builders.ParameterBuilder
Updates the parameter extensions
vendorExtensions(List<VendorExtension>) - Method in class springfox.documentation.builders.ResponseMessageBuilder
Updates the response message extensions
VendorExtensionsMapper - Class in springfox.documentation.swagger2.mappers
 
VendorExtensionsMapper() -