A B C D E F G H I J K L M N O P Q R S T U V W X
All Classes All Packages
All Classes All Packages
A
- AbstractDocumentationPluginsBootstrapper - Class in springfox.documentation.spring.web.plugins
- AbstractDocumentationPluginsBootstrapper(DocumentationPluginsManager, List<RequestHandlerProvider>, DocumentationCache, ApiDocumentationScanner, Defaults, TypeResolver, PathProvider) - Constructor for class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
- AbstractOperationParameterRequestConditionReader - Class in springfox.documentation.spring.web.readers.operation
- AbstractOperationParameterRequestConditionReader(TypeResolver) - Constructor for class springfox.documentation.spring.web.readers.operation.AbstractOperationParameterRequestConditionReader
- accepts(Collection<MediaType>) - Method in class springfox.documentation.builders.RequestParameterBuilder
- 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(ModelSpecification) - Method in class springfox.documentation.spring.web.scanners.ModelSpecificationRegistryBuilder
- addAll(Collection<ModelSpecification>) - Method in class springfox.documentation.spring.web.scanners.ModelSpecificationRegistryBuilder
- addDocumentation(Documentation) - Method in class springfox.documentation.spring.web.DocumentationCache
- addInputParam(ResolvedType) - Method in class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder
- addInputParam(ResolvedType, Optional<ResolvedType>, Set<ResolvedType>) - 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(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
- additionalModels(Set<ResolvedType>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
- additionalOperationParameters(List<Parameter>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
- additionalQueryStringParams(Map<String, Object>) - Method in class springfox.documentation.swagger.web.SecurityConfigurationBuilder
- additionalRequestParameters(List<RequestParameter>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
- additionalResponseMessages(Map<RequestMethod, List<ResponseMessage>>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
- additionalResponses(Map<HttpMethod, List<Response>>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
- addProperty(VendorExtension) - Method in class springfox.documentation.service.ObjectVendorExtension
- addResourceHandlers(ResourceHandlerRegistry) - Method in class springfox.boot.starter.autoconfigure.SwaggerUiWebFluxConfigurer
- addResourceHandlers(ResourceHandlerRegistry) - Method in class springfox.boot.starter.autoconfigure.SwaggerUiWebMvcConfigurer
- addReturn(ResolvedType) - Method in class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder
- addReturn(ResolvedType, Optional<ResolvedType>) - Method in class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder
- addRule(AlternateTypeRule) - Method in class springfox.documentation.spi.schema.AlternateTypeProvider
- addServer(Server) - Method in class springfox.documentation.service.Documentation
- addValidVendorExtensions(List<VendorExtension>) - Method in class springfox.documentation.service.SecurityScheme
- addViewControllers(ViewControllerRegistry) - Method in class springfox.boot.starter.autoconfigure.SwaggerUiWebMvcConfigurer
- 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
- afterMappingParameter(Example, Example) - Method in interface springfox.documentation.oas.mappers.ExamplesMapper
- afterMappingParameter(RequestParameter, Parameter) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- aggregate(Collection<RequestParameter>) - Method in class springfox.documentation.spring.web.readers.operation.ContentParameterAggregator
- aggregate(Collection<RequestParameter>) - Method in interface springfox.documentation.spring.web.readers.operation.ParameterAggregator
- all() - Method in class springfox.documentation.spring.web.DocumentationCache
- ALL_OF - springfox.documentation.service.Qualifier
- allExamples(Example) - Static method in class springfox.documentation.swagger.readers.parameter.Examples
- allExamples(String, ExampleObject[]) - Static method in class springfox.documentation.swagger.readers.parameter.Examples
- AllowableListValues - Class in springfox.documentation.service
- 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.service.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 - Class in springfox.documentation.swagger1.dto
- AllowableRangeValues() - Constructor for class springfox.documentation.swagger1.dto.AllowableRangeValues
- AllowableRangeValues(String, Boolean, String, Boolean) - Constructor for class springfox.documentation.service.AllowableRangeValues
- AllowableRangeValues(String, String) - Constructor for class springfox.documentation.service.AllowableRangeValues
- AllowableRangeValues(String, String) - Constructor for class springfox.documentation.swagger1.dto.AllowableRangeValues
- allowableValueFromString(String) - Static method in class springfox.documentation.swagger.schema.ApiModelProperties
- 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(Class<?>) - Static method in class springfox.documentation.schema.Enums
- allowableValues(AllowableValues) - Method in class springfox.documentation.builders.ModelPropertyBuilder
- allowableValues(AllowableValues) - Method in class springfox.documentation.builders.ParameterBuilder
-
Deprecated.Updates if the parameter is bound by a range of values or a range of numerical values
- 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
- allowedValues(Collection<String>) - Method in class springfox.documentation.builders.EnumerationElementFacetBuilder
- allowedValues(List<String>) - Method in class springfox.documentation.builders.ServerVariableBuilder
- allowedValues(AllowableValues) - Method in class springfox.documentation.builders.EnumerationElementFacetBuilder
- allowEmptyValue(Boolean) - Method in class springfox.documentation.builders.ModelPropertyBuilder
-
Support for isAllowEmpty value
- allowEmptyValue(Boolean) - Method in class springfox.documentation.builders.ParameterBuilder
-
Deprecated.Updates the flag that allows sending empty values for this parameter
- allowEmptyValue(Boolean) - Method in class springfox.documentation.builders.PropertySpecificationBuilder
- allowEmptyValue(Boolean) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder
-
Allows empty values
- allowMultiple(boolean) - Method in class springfox.documentation.builders.ParameterBuilder
-
Deprecated.Updates if the parameter should allow multiple values
- allowReserved(Boolean) - Method in class springfox.documentation.builders.EncodingBuilder
- allowReserved(Boolean) - Method in class springfox.documentation.builders.ParameterBuilder
-
Deprecated.
- allowReserved(Boolean) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder
-
Allows reserved characters
- ALPHA - springfox.documentation.swagger.web.OperationsSorter
- ALPHA - springfox.documentation.swagger.web.TagsSorter
- alternateEvaluatedType() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
- alternateFor(ResolvedType) - Method in class springfox.documentation.schema.AlternateTypeRule
-
Provides alternate for supplier type.
- 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
- alternateFor(ResolvedType) - Method in class springfox.documentation.spi.service.contexts.ResponseContext
- 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
-
Deprecated.
- 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(AlternateTypeRule...) - Method in class springfox.documentation.spring.web.plugins.Docket
-
Adds model substitution rules (alternateTypeRules)
- AlternateTypeRules - Class in springfox.documentation.schema
- 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(List<Annotation>) - Method in class springfox.documentation.builders.AlternateTypeBuilder
- annotations(List<Annotation>) - Method in class springfox.documentation.builders.AlternateTypePropertyBuilder
- 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
- ANY_OF - springfox.documentation.service.Qualifier
- ApiDescription - Class in springfox.documentation.service
- ApiDescription - Class in springfox.documentation.swagger1.dto
- ApiDescription() - Constructor for class springfox.documentation.swagger1.dto.ApiDescription
- ApiDescription(String, String, String, String, List<Operation>, Boolean) - Constructor for class springfox.documentation.service.ApiDescription
- ApiDescription(String, String, List<Operation>, Boolean) - Constructor for class springfox.documentation.swagger1.dto.ApiDescription
- apiDescriptionBuilder() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
- ApiDescriptionBuilder - Class in springfox.documentation.builders
- ApiDescriptionBuilder(Comparator<Operation>) - Constructor for class springfox.documentation.builders.ApiDescriptionBuilder
- 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() - Method in class springfox.documentation.spring.web.scanners.ApiListingScanningContext
- 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. - 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(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.service
- 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
- ApiInfo(String, String, String, String, String, String, String) - Constructor for class springfox.documentation.service.ApiInfo
-
Deprecated.
- ApiInfo(String, String, String, String, Contact, String, String, Collection<VendorExtension>) - Constructor for class springfox.documentation.service.ApiInfo
-
Default contstructor
- 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.oas.mappers.LicenseMapper
- apiInfoToLicense(ApiInfo) - Method in class springfox.documentation.swagger2.mappers.LicenseMapper
- ApiKey - Class in springfox.documentation.service
- ApiKey - Class in springfox.documentation.swagger1.dto
- ApiKey() - Constructor for class springfox.documentation.swagger1.dto.ApiKey
- ApiKey(String) - Constructor for class springfox.documentation.swagger1.dto.ApiKey
- ApiKey(String, String) - Constructor for class springfox.documentation.swagger1.dto.ApiKey
- ApiKey(String, String, String) - Constructor for class springfox.documentation.service.ApiKey
- ApiKey(String, String, String, List<VendorExtension>) - Constructor for class springfox.documentation.service.ApiKey
- ApiKeyVehicle - Enum in springfox.documentation.swagger.web
- apiListing(ApiListingContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
- ApiListing - Class in springfox.documentation.service
- ApiListing - Class in springfox.documentation.swagger1.dto
- ApiListing() - Constructor for class springfox.documentation.swagger1.dto.ApiListing
- ApiListing(String, String, String, Set<String>, Set<String>, String, Set<String>, List<SecurityReference>, List<ApiDescription>, Map<String, Model>, Map<String, ModelSpecification>, ModelNamesRegistry, String, int, Set<Tag>) - Constructor for class springfox.documentation.service.ApiListing
- apiListingBuilder() - Method in class springfox.documentation.spi.service.contexts.ApiListingContext
- ApiListingBuilder - Class in springfox.documentation.builders
- ApiListingBuilder(Comparator<ApiDescription>) - Constructor for class springfox.documentation.builders.ApiListingBuilder
-
Update the sorting order for api descriptions
- 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
- 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 - Class in springfox.documentation.swagger1.dto
- ApiListingReference() - Constructor for class springfox.documentation.swagger1.dto.ApiListingReference
- ApiListingReference(String, String, int) - Constructor for class springfox.documentation.service.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, ApiModelSpecificationReader, 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, EnumTypeDeterminer, ModelSpecificationFactory) - Constructor for class springfox.documentation.swagger.schema.ApiModelBuilder
- ApiModelProperties - Class in springfox.documentation.swagger.schema
- ApiModelPropertyPropertyBuilder - Class in springfox.documentation.swagger.schema
- ApiModelPropertyPropertyBuilder(DescriptionResolver, ModelSpecificationFactory) - Constructor for class springfox.documentation.swagger.schema.ApiModelPropertyPropertyBuilder
- ApiModelReader - Class in springfox.documentation.spring.web.scanners
-
Deprecated.
- ApiModelReader(ModelProvider, TypeResolver, DocumentationPluginsManager, EnumTypeDeterminer, TypeNameExtractor) - Constructor for class springfox.documentation.spring.web.scanners.ApiModelReader
-
Deprecated.
- ApiModelSpecificationReader - Class in springfox.documentation.spring.web.scanners
- ApiModelSpecificationReader(ModelSpecificationProvider, DocumentationPluginsManager, TypeResolver) - Constructor for class springfox.documentation.spring.web.scanners.ApiModelSpecificationReader
- 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, String) - Constructor for class springfox.documentation.swagger.web.ApiResourceController
- apis(Predicate<RequestHandler>) - Method in class springfox.documentation.spring.web.plugins.ApiSelectorBuilder
- 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
- 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.
- apply(DynamicType.Builder<Object>) - Method in class springfox.documentation.builders.AlternateTypePropertyBuilder
- apply(ModelContext) - Method in class springfox.documentation.schema.plugins.JacksonXmlModelPlugin
- apply(ModelContext) - Method in class springfox.documentation.schema.plugins.JsonIgnorePropertiesModelPlugin
- apply(ModelContext) - Method in class springfox.documentation.schema.plugins.PropertyDiscriminatorBasedInheritancePlugin
- apply(ModelContext) - Method in class springfox.documentation.schema.plugins.XmlModelPlugin
- 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(ModelContext) - Method in class springfox.documentation.swagger.schema.ApiModelBuilder
- apply(ModelPropertyContext) - Method in class springfox.bean.validators.plugins.schema.DecimalMinMaxAnnotationPlugin
- apply(ModelPropertyContext) - Method in class springfox.bean.validators.plugins.schema.IsNullAnnotationPlugin
-
read NotNull annotation
- apply(ModelPropertyContext) - Method in class springfox.bean.validators.plugins.schema.MinMaxAnnotationPlugin
- apply(ModelPropertyContext) - Method in class springfox.bean.validators.plugins.schema.NotBlankAnnotationPlugin
-
read NotBlank annotation
- 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(ModelPropertyContext) - Method in class springfox.documentation.schema.property.JacksonXmlPropertyPlugin
- apply(ModelPropertyContext) - Method in class springfox.documentation.schema.property.XmlPropertyPlugin
- 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(ModelPropertyContext) - Method in class springfox.documentation.swagger.schema.ApiModelPropertyPropertyBuilder
- apply(ModelPropertyContext) - Method in class springfox.documentation.swagger.schema.OpenApiSchemaPropertyBuilder
- apply(ApiListingContext) - Method in interface springfox.documentation.spi.service.ApiListingBuilderPlugin
-
Implement this method to override the ApiListing using the ApiListingBuilder
- apply(ApiListingContext) - Method in class springfox.documentation.spring.web.scanners.ApiListingReader
- apply(ApiListingContext) - Method in class springfox.documentation.spring.web.scanners.MediaTypeReader
- apply(ApiListingContext) - Method in class springfox.documentation.swagger.web.SwaggerApiListingReader
- apply(DocumentationContext) - Method in interface springfox.documentation.spi.service.ApiListingScannerPlugin
-
Implement this method to manually add ApiDescriptions
- apply(DocumentationContextBuilder) - Method in interface springfox.documentation.spi.service.DefaultsProviderPlugin
-
Implement this method to override enrich the documentation context builder with documentation type specific defaults.
- apply(DocumentationContextBuilder) - Method in class springfox.documentation.spring.web.plugins.DefaultConfiguration
- apply(DocumentationContextBuilder) - Method in class springfox.documentation.spring.web.plugins.WebfluxDefaultsProvider
- apply(DocumentationContextBuilder) - Method in class springfox.documentation.swagger1.web.SwaggerDefaultConfiguration
- 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(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(OperationContext) - Method in class springfox.documentation.spring.web.readers.operation.OperationParameterHeadersConditionReader
- apply(OperationContext) - Method in class springfox.documentation.spring.web.readers.operation.OperationParameterReader
- apply(OperationContext) - Method in class springfox.documentation.spring.web.readers.operation.OperationParameterRequestConditionReader
- apply(OperationContext) - Method in class springfox.documentation.spring.web.readers.operation.OperationResponseClassReader
- apply(OperationContext) - Method in class springfox.documentation.spring.web.readers.operation.OperationTagsReader
- apply(OperationContext) - Method in class springfox.documentation.spring.web.readers.operation.ResponseMessagesReader
- apply(OperationContext) - Method in class springfox.documentation.spring.web.scanners.MediaTypeReader
- apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.OpenApiOperationAuthReader
- apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.OpenApiOperationTagsReader
- apply(OperationContext) - Method in class springfox.documentation.swagger.readers.operation.OpenApiResponseReader
- 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(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.bean.validators.plugins.parameter.MinMaxAnnotationPlugin
- apply(ParameterContext) - Method in class springfox.bean.validators.plugins.parameter.NotBlankAnnotationPlugin
- 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(ParameterContext) - Method in interface springfox.documentation.spi.service.ParameterBuilderPlugin
-
Implement this method to collect input parameters and return values
- 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(ParameterContext) - Method in class springfox.documentation.swagger.readers.parameter.ApiParamParameterBuilder
- apply(ParameterContext) - Method in class springfox.documentation.swagger.readers.parameter.OpenApiParameterBuilder
- apply(ParameterContext) - Method in class springfox.documentation.swagger1.readers.parameter.ParameterNameReader
- apply(ParameterExpansionContext) - Method in class springfox.bean.validators.plugins.parameter.ExpandedParameterMinMaxAnnotationPlugin
- apply(ParameterExpansionContext) - Method in class springfox.bean.validators.plugins.parameter.ExpandedParameterNotBlankAnnotationPlugin
- 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(ParameterExpansionContext) - Method in interface springfox.documentation.spi.service.ExpandedParameterBuilderPlugin
-
Implement this method to override the Parameter using ParameterBuilder available in the context
- apply(ParameterExpansionContext) - Method in class springfox.documentation.spring.web.readers.parameter.ExpandedParameterBuilder
- apply(ParameterExpansionContext) - Method in class springfox.documentation.swagger.readers.parameter.SwaggerExpandedParameterBuilder
- apply(RequestMappingContext) - Method in interface springfox.documentation.spi.service.OperationModelsProviderPlugin
-
Implement this method to collect input parameters and return values
- apply(RequestMappingContext) - Method in class springfox.documentation.spring.web.readers.operation.OperationModelsProvider
- apply(RequestMappingContext) - Method in class springfox.documentation.swagger.readers.operation.SwaggerOperationModelsProvider
- apply(ResponseContext) - Method in interface springfox.documentation.spi.service.ResponseBuilderPlugin
-
Implement this method to enrich return values
- apply(ResponseContext) - Method in class springfox.documentation.spring.web.plugins.DefaultResponseTypeReader
- applyDefaultResponseMessages(boolean) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
- applyDefaults(DocumentationType, DocumentationContextBuilder) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
- appName(String) - Method in class springfox.documentation.swagger.web.SecurityConfigurationBuilder
- ARRAY - springfox.documentation.schema.CollectionType
- 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 - Class in springfox.documentation.swagger1.dto
- AuthorizationCodeGrant() - Constructor for class springfox.documentation.swagger1.dto.AuthorizationCodeGrant
- AuthorizationCodeGrant(TokenRequestEndpoint, TokenEndpoint) - Constructor for class springfox.documentation.service.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 - Class in springfox.documentation.swagger1.dto
- AuthorizationScope() - Constructor for class springfox.documentation.swagger1.dto.AuthorizationScope
- AuthorizationScope(String, String) - Constructor for class springfox.documentation.service.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
- authorizationUrl(String) - Method in class springfox.documentation.builders.OAuth2SchemeBuilder
- availableTags(Set<Tag>) - Method in class springfox.documentation.builders.ApiListingBuilder
-
Globally configured tags
B
- baseModel(String) - Method in class springfox.documentation.builders.ModelBuilder
-
Deprecated.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() - Method in class springfox.documentation.spring.data.rest.EntityContext
- 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
- BasePathAwareServicesProvider - Class in springfox.documentation.spring.data.rest
- BasePathAwareServicesProvider(RepositoryRestConfiguration, ApplicationContext, HandlerMethodResolver, ServletContext) - Constructor for class springfox.documentation.spring.data.rest.BasePathAwareServicesProvider
- BASIC_AUTH_BUILDER - Static variable in class springfox.documentation.service.HttpAuthenticationScheme
- BasicAuth - Class in springfox.documentation.service
- BasicAuth - Class in springfox.documentation.swagger1.dto
- BasicAuth() - Constructor for class springfox.documentation.swagger1.dto.BasicAuth
- BasicAuth(String) - Constructor for class springfox.documentation.service.BasicAuth
- BasicAuth(String, List<VendorExtension>) - Constructor for class springfox.documentation.service.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
- bearerFormat(String) - Method in class springfox.documentation.builders.HttpAuthenticationBuilder
- BIGDECIMAL - Static variable in class springfox.documentation.schema.ScalarType
- BIGINTEGER - Static variable in class springfox.documentation.schema.ScalarType
- BINARY - Static variable in class springfox.documentation.schema.ScalarType
- BODY - springfox.documentation.service.ParameterType
- BodyParameterSpecificationProvider - Class in springfox.documentation.builders
- BodyParameterSpecificationProvider() - Constructor for class springfox.documentation.builders.BodyParameterSpecificationProvider
- BOOLEAN - Static variable in class springfox.documentation.schema.ScalarType
- 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.CollectionElementFacetBuilder
- build() - Method in class springfox.documentation.builders.CollectionSpecificationBuilder
- build() - Method in class springfox.documentation.builders.CompoundModelSpecificationBuilder
- build() - Method in class springfox.documentation.builders.DocumentationBuilder
- build() - Method in interface springfox.documentation.builders.ElementFacetBuilder
- build() - Method in class springfox.documentation.builders.EncodingBuilder
- build() - Method in class springfox.documentation.builders.EnumerationElementFacetBuilder
- build() - Method in class springfox.documentation.builders.ExampleBuilder
- build() - Method in class springfox.documentation.builders.ExternalDocumentationBuilder
- build() - Method in class springfox.documentation.builders.HttpAuthenticationBuilder
- build() - Method in class springfox.documentation.builders.ImplicitGrantBuilder
- build() - Method in class springfox.documentation.builders.LoginEndpointBuilder
- build() - Method in class springfox.documentation.builders.MapSpecificationBuilder
- build() - Method in class springfox.documentation.builders.ModelBuilder
-
Deprecated.
- build() - Method in class springfox.documentation.builders.ModelFacetsBuilder
- build() - Method in class springfox.documentation.builders.ModelPropertyBuilder
- build() - Method in class springfox.documentation.builders.ModelSpecificationBuilder
- build() - Method in class springfox.documentation.builders.OAuth2SchemeBuilder
- build() - Method in class springfox.documentation.builders.OAuthBuilder
- build() - Method in class springfox.documentation.builders.OpenIdConnectSchemeBuilder
- build() - Method in class springfox.documentation.builders.OperationBuilder
- build() - Method in class springfox.documentation.builders.ParameterBuilder
-
Deprecated.
- build() - Method in class springfox.documentation.builders.PropertySpecificationBuilder
- build() - Method in class springfox.documentation.builders.QualifiedModelNameBuilder
- build() - Method in class springfox.documentation.builders.ReferenceModelSpecificationBuilder
- build() - Method in class springfox.documentation.builders.RepresentationBuilder
- build() - Method in class springfox.documentation.builders.RequestParameterBuilder
- build() - Method in class springfox.documentation.builders.ResourceListingBuilder
- build() - Method in class springfox.documentation.builders.ResponseBuilder
- build() - Method in class springfox.documentation.builders.ResponseMessageBuilder
-
Deprecated.
- build() - Method in class springfox.documentation.builders.ServerBuilder
- build() - Method in class springfox.documentation.builders.StringElementFacetBuilder
- build() - Method in class springfox.documentation.builders.TokenEndpointBuilder
- build() - Method in class springfox.documentation.builders.TokenRequestEndpointBuilder
- build() - Method in class springfox.documentation.schema.ModelKeyBuilder
- build() - Method in class springfox.documentation.schema.NumericElementFacetBuilder
- 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.spring.web.scanners.ModelSpecificationRegistryBuilder
- 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
- builderFactory(Class<T>) - Static method in class springfox.documentation.builders.ElementFacets
- builtInScalarType(Type) - Static method in class springfox.documentation.schema.ScalarTypes
- 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
- BYTE - Static variable in class springfox.documentation.schema.ScalarType
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, ModelSpecificationProvider) - 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
- canRead(boolean) - Method in class springfox.documentation.builders.AlternateTypePropertyBuilder
- canWrite(boolean) - Method in class springfox.documentation.builders.AlternateTypePropertyBuilder
- childContext(String, ResolvedType, OperationContext) - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext
- classByName(String) - Static method in class springfox.documentation.schema.ClassSupport
- classByName(String, ClassLoader) - Static method in class springfox.documentation.schema.ClassSupport
- ClassNotPresentInClassPathCondition - Class in springfox.documentation.common
- ClassNotPresentInClassPathCondition() - Constructor for class springfox.documentation.common.ClassNotPresentInClassPathCondition
- ClassPresentInClassPathCondition - Class in springfox.documentation.common
- ClassPresentInClassPathCondition() - Constructor for class springfox.documentation.common.ClassPresentInClassPathCondition
- ClassSupport - Class in springfox.documentation.schema
- clear() - Method in class springfox.documentation.spring.web.DocumentationCache
- clearEncodings() - Method in class springfox.documentation.builders.RepresentationBuilder
- 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
-
Deprecated.Updates the http response code
- code(String) - Method in class springfox.documentation.builders.ResponseBuilder
- 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.
- CollectionElementFacet - Class in springfox.documentation.schema
- CollectionElementFacet(Integer, Integer, Boolean) - Constructor for class springfox.documentation.schema.CollectionElementFacet
- CollectionElementFacetBuilder - Class in springfox.documentation.builders
- CollectionElementFacetBuilder() - Constructor for class springfox.documentation.builders.CollectionElementFacetBuilder
- collectionElementType(ResolvedType) - Static method in class springfox.documentation.schema.Collections
- collectionFacet(Consumer<CollectionElementFacetBuilder>) - Method in class springfox.documentation.builders.ModelFacetsBuilder
- collectionFacet(Consumer<CollectionElementFacetBuilder>) - Method in class springfox.documentation.builders.PropertySpecificationBuilder
- collectionFacet(Consumer<CollectionElementFacetBuilder>) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder
-
Provides consumer to help uild collection element facet
- collectionFormat(String) - Method in class springfox.documentation.builders.ParameterBuilder
-
Deprecated.Updates the parameter extensions
- collectionFormat(CollectionFormat) - Method in class springfox.documentation.builders.CollectionElementFacetBuilder
- collectionFormat(CollectionFormat) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder
-
Deprecated.
- CollectionFormat - Class in springfox.documentation.service
- collectionModel(Consumer<CollectionSpecificationBuilder>) - Method in class springfox.documentation.builders.ModelSpecificationBuilder
-
Provides a consumer to build the collection model
- collectionModelIfExists(Consumer<CollectionSpecificationBuilder>) - Method in class springfox.documentation.builders.ModelSpecificationBuilder
-
Conditionally provides a consumer to build the colleciton model.
- Collections - Class in springfox.documentation.schema
- CollectionSpecification - Class in springfox.documentation.schema
- CollectionSpecification(ModelSpecification, CollectionType) - Constructor for class springfox.documentation.schema.CollectionSpecification
- CollectionSpecificationBuilder - Class in springfox.documentation.builders
- CollectionSpecificationBuilder() - Constructor for class springfox.documentation.builders.CollectionSpecificationBuilder
- CollectionSpecificationProvider - Class in springfox.documentation.schema.property
- CollectionSpecificationProvider(ModelSpecificationFactory) - Constructor for class springfox.documentation.schema.property.CollectionSpecificationProvider
- CollectionSpecificationToPropertyConverter - Class in springfox.documentation.swagger2.mappers
- CollectionSpecificationToPropertyConverter(ModelNamesRegistry) - Constructor for class springfox.documentation.swagger2.mappers.CollectionSpecificationToPropertyConverter
- CollectionSpecificationToSchemaConverter - Class in springfox.documentation.oas.mappers
- CollectionSpecificationToSchemaConverter(ModelNamesRegistry) - Constructor for class springfox.documentation.oas.mappers.CollectionSpecificationToSchemaConverter
- collectionType(ResolvedType) - Static method in class springfox.documentation.schema.Collections
- collectionType(CollectionType) - Method in class springfox.documentation.builders.CollectionSpecificationBuilder
- CollectionType - Enum in springfox.documentation.schema
- combine(List<RequestHandler>) - Method in interface springfox.documentation.spi.service.RequestHandlerCombiner
- 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(RequestHandler) - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
- combine(RequestHandler) - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
- combine(RequestHandler) - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
- combine(PatternsRequestCondition<PatternsRequestCondition>) - Method in class springfox.documentation.spring.web.WebFluxPatternsRequestConditionWrapper
- combine(PatternsRequestCondition<PatternsRequestCondition>) - Method in class springfox.documentation.spring.web.WebMvcPatternsRequestConditionWrapper
- 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
- ComparisonCondition - Class in springfox.documentation.spring.web.scanners
- ComparisonCondition(String, Set<String>, Set<String>) - Constructor for class springfox.documentation.spring.web.scanners.ComparisonCondition
- Compatibility<T,U> - Class in springfox.documentation.common
- Compatibility(T, U) - Constructor for class springfox.documentation.common.Compatibility
- CompatibilityModelMapper - Class in springfox.documentation.swagger2.mappers
- CompatibilityModelMapper() - Constructor for class springfox.documentation.swagger2.mappers.CompatibilityModelMapper
- complexExamples(Map<String, List<Example>>) - Method in class springfox.documentation.builders.ParameterBuilder
-
Deprecated.
- componentsFrom(HttpServletRequest, String) - Static method in class springfox.documentation.swagger.common.HostNameProvider
- compoundModel(Consumer<CompoundModelSpecificationBuilder>) - Method in class springfox.documentation.builders.ModelSpecificationBuilder
-
Provides a consumer to help building a compound model
- compoundModelIfExists(Consumer<CompoundModelSpecificationBuilder>) - Method in class springfox.documentation.builders.ModelSpecificationBuilder
-
Provides a consumer to help build a compound model if one already exists.
- CompoundModelSpecification - Class in springfox.documentation.schema
- CompoundModelSpecification(ModelKey, Collection<PropertySpecification>, Integer, Integer, String, List<ReferenceModelSpecification>) - Constructor for class springfox.documentation.schema.CompoundModelSpecification
- CompoundModelSpecificationBuilder - Class in springfox.documentation.builders
- CompoundModelSpecificationBuilder() - Constructor for class springfox.documentation.builders.CompoundModelSpecificationBuilder
- CompoundSpecificationToPropertyConverter - Class in springfox.documentation.swagger2.mappers
- CompoundSpecificationToPropertyConverter(ModelNamesRegistry) - Constructor for class springfox.documentation.swagger2.mappers.CompoundSpecificationToPropertyConverter
- CompoundSpecificationToSchemaConverter - Class in springfox.documentation.oas.mappers
- CompoundSpecificationToSchemaConverter(ModelNamesRegistry) - Constructor for class springfox.documentation.oas.mappers.CompoundSpecificationToSchemaConverter
- 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() - Method in interface springfox.documentation.RequestHandler
- 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() - Method in class springfox.documentation.spring.web.WebFluxRequestHandler
- consumes() - Method in class springfox.documentation.spring.web.WebMvcRequestHandler
- 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(Set<String>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
- consumes(Set<String>) - Method in class springfox.documentation.spring.web.plugins.Docket
- 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
- containsModel(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext
- content(Consumer<ContentSpecificationBuilder>) - Method in class springfox.documentation.builders.RequestParameterBuilder
- contentModel(ModelSpecification) - Method in class springfox.documentation.builders.RequestParameterBuilder
- ContentParameterAggregator - Class in springfox.documentation.spring.web.readers.operation
- ContentParameterAggregator() - Constructor for class springfox.documentation.spring.web.readers.operation.ContentParameterAggregator
- ContentSpecification - Class in springfox.documentation.service
- ContentSpecification(boolean, Set<Representation>) - Constructor for class springfox.documentation.service.ContentSpecification
- ContentSpecificationBuilder - Class in springfox.documentation.builders
- ContentSpecificationBuilder() - Constructor for class springfox.documentation.builders.ContentSpecificationBuilder
- contentType(String) - Method in class springfox.documentation.builders.EncodingBuilder
- contextPath() - Method in class springfox.documentation.spring.data.rest.EntityContext
- contextPath(String) - 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
- convert(Object) - Method in class springfox.documentation.spring.data.rest.OptionalDeferencer
- convert(String) - Static method in class springfox.documentation.service.CollectionFormat
- convert(CollectionSpecification) - Method in class springfox.documentation.oas.mappers.CollectionSpecificationToSchemaConverter
- convert(CollectionSpecification) - Method in class springfox.documentation.swagger2.mappers.CollectionSpecificationToPropertyConverter
- convert(CompoundModelSpecification) - Method in class springfox.documentation.oas.mappers.CompoundSpecificationToSchemaConverter
- convert(CompoundModelSpecification) - Method in class springfox.documentation.swagger2.mappers.CompoundSpecificationToPropertyConverter
- convert(MapSpecification) - Method in class springfox.documentation.oas.mappers.MapSpecificationToSchemaConverter
- convert(MapSpecification) - Method in class springfox.documentation.swagger2.mappers.MapSpecificationToPropertyConverter
- convert(ReferenceModelSpecification) - Method in class springfox.documentation.oas.mappers.ReferenceModelSpecificationToSchemaConverter
- convert(ReferenceModelSpecification) - Method in class springfox.documentation.swagger2.mappers.ReferenceModelSpecificationToPropertyConverter
- convert(ScalarModelSpecification) - Method in class springfox.documentation.oas.mappers.ScalarModelToSchemaConverter
- convert(ScalarModelSpecification) - Method in class springfox.documentation.swagger2.mappers.ScalarModelToPropertyConverter
- COOKIE - springfox.documentation.service.ParameterType
- CookieParameterSpecificationProvider - Class in springfox.documentation.builders
- CookieParameterSpecificationProvider() - Constructor for class springfox.documentation.builders.CookieParameterSpecificationProvider
- copy() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
- copyOf(CollectionSpecification) - Method in class springfox.documentation.builders.CollectionSpecificationBuilder
- copyOf(CompoundModelSpecification) - Method in class springfox.documentation.builders.CompoundModelSpecificationBuilder
-
Copies from an existing model
- copyOf(ElementFacet) - Method in class springfox.documentation.builders.CollectionElementFacetBuilder
- copyOf(ElementFacet) - Method in interface springfox.documentation.builders.ElementFacetBuilder
- copyOf(ElementFacet) - Method in class springfox.documentation.builders.EnumerationElementFacetBuilder
- copyOf(ElementFacet) - Method in class springfox.documentation.builders.StringElementFacetBuilder
- copyOf(ElementFacet) - Method in class springfox.documentation.schema.NumericElementFacetBuilder
- copyOf(MapSpecification) - Method in class springfox.documentation.builders.MapSpecificationBuilder
- copyOf(ModelFacets) - Method in class springfox.documentation.builders.ModelFacetsBuilder
- copyOf(ModelKey) - Method in class springfox.documentation.schema.ModelKeyBuilder
- copyOf(ModelSpecification) - Method in class springfox.documentation.builders.ModelSpecificationBuilder
-
Copies from an other model
- copyOf(QualifiedModelName) - Method in class springfox.documentation.builders.QualifiedModelNameBuilder
- copyOf(ReferenceModelSpecification) - Method in class springfox.documentation.builders.ReferenceModelSpecificationBuilder
- copyOf(ContentSpecification) - Method in class springfox.documentation.builders.ContentSpecificationBuilder
- copyOf(Encoding) - Method in class springfox.documentation.builders.EncodingBuilder
- copyOf(Representation) - Method in class springfox.documentation.builders.RepresentationBuilder
- copyOf(RequestParameter) - Method in class springfox.documentation.builders.RequestParameterBuilder
- copyOf(Response) - Method in class springfox.documentation.builders.ResponseBuilder
- copyOf(SimpleParameterSpecification) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder
-
Method they copy from a specification
- copyOf(SecurityConfiguration) - Method in class springfox.documentation.swagger.web.SecurityConfigurationBuilder
- copyOf(UiConfiguration) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
- copyPatternUsing(String) - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
- create(ParameterSpecificationContext) - Method in class springfox.documentation.builders.BodyParameterSpecificationProvider
- create(ParameterSpecificationContext) - Method in class springfox.documentation.builders.CookieParameterSpecificationProvider
- create(ParameterSpecificationContext) - Method in class springfox.documentation.builders.FormParameterSpecificationProvider
- create(ParameterSpecificationContext) - Method in class springfox.documentation.builders.HeaderParameterSpecificationProvider
- create(ParameterSpecificationContext) - Method in class springfox.documentation.builders.MultipartFormDataParameterSpecificationProvider
- create(ParameterSpecificationContext) - Method in interface springfox.documentation.builders.ParameterSpecificationProvider
- create(ParameterSpecificationContext) - Method in class springfox.documentation.builders.PathParameterSpecificationProvider
- create(ParameterSpecificationContext) - Method in class springfox.documentation.builders.RootParameterSpecificationProvider
- create(SecurityScheme) - Method in class springfox.documentation.swagger2.mappers.HttpAuthenticationSchemeFactory
- create(SecurityScheme) - Method in class springfox.documentation.swagger2.mappers.OpenIdConnectSchemeFactory
- create(DocumentationType) - Method in interface springfox.documentation.spi.service.DefaultsProviderPlugin
-
Deprecated.
- create(DocumentationType) - Method in class springfox.documentation.spring.web.plugins.DefaultConfiguration
- create(DocumentationType) - Method in class springfox.documentation.spring.web.plugins.WebfluxDefaultsProvider
- create(DocumentationType) - Method in class springfox.documentation.swagger1.web.SwaggerDefaultConfiguration
- create(ModelContext) - Method in interface springfox.documentation.spi.schema.SyntheticModelProviderPlugin
-
Creates a synthetic model
- create(ModelContext, ResolvedType) - Method in class springfox.documentation.schema.property.ModelSpecificationFactory
- createModelSpecification(ModelContext) - Method in interface springfox.documentation.spi.schema.SyntheticModelProviderPlugin
-
Creates a synthetic model
- createServerVariable() - Method in class springfox.documentation.builders.ServerVariableBuilder
- 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
- CSV - Static variable in class springfox.documentation.service.CollectionFormat
- CURRENCY - Static variable in class springfox.documentation.schema.ScalarType
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
-
Deprecated.
- DataTypeMapper() - Constructor for class springfox.documentation.swagger1.mappers.DataTypeMapper
-
Deprecated.
- DataTypeMapper.ItemType - Annotation Type in springfox.documentation.swagger1.mappers
-
Deprecated.
- DataTypeMapper.OperationType - Annotation Type in springfox.documentation.swagger1.mappers
-
Deprecated.
- DataTypeMapper.ResponseTypeName - Annotation Type in springfox.documentation.swagger1.mappers
-
Deprecated.
- DataTypeMapper.Type - Annotation Type in springfox.documentation.swagger1.mappers
-
Deprecated.
- DATE - Static variable in class springfox.documentation.schema.ScalarType
- DATE_TIME - Static variable in class springfox.documentation.schema.ScalarType
- 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.
- 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.oas.web.SpecGeneration
- decode(String) - Method in class springfox.documentation.oas.web.WebFluxBasePathAndHostnameTransformationFilter
- 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
- DEEPOBJECT - springfox.documentation.service.ParameterStyle
- DEFAULT - springfox.documentation.service.ParameterStyle
- 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_MULTIPLE - Static variable in class springfox.documentation.schema.NumericElementFacet
- DEFAULT_PRECEDENCE - Static variable in class springfox.documentation.service.RequestParameter
- DEFAULT_SUBMIT_METHODS - Static variable in class springfox.documentation.swagger.web.UiConfiguration.Constants
- 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
- DefaultModelNamesRegistryFactory - Class in springfox.documentation.spring.web.scanners
- DefaultModelNamesRegistryFactory() - Constructor for class springfox.documentation.spring.web.scanners.DefaultModelNamesRegistryFactory
- DefaultModelProvider - Class in springfox.documentation.schema
-
Deprecated.
- DefaultModelProvider(ModelPropertiesProvider, ModelDependencyProvider, SchemaPluginsManager, TypeNameExtractor, EnumTypeDeterminer) - Constructor for class springfox.documentation.schema.DefaultModelProvider
-
Deprecated.
- defaultModelRendering(ModelRendering) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
- defaultModelsExpandDepth(Integer) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
- DefaultModelSpecificationProvider - Class in springfox.documentation.schema
- DefaultModelSpecificationProvider(TypeResolver, ModelPropertiesProvider, ModelDependencyProvider, SchemaPluginsManager, TypeNameExtractor, EnumTypeDeterminer, ModelSpecificationFactory) - Constructor for class springfox.documentation.schema.DefaultModelSpecificationProvider
- 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
-
Deprecated.
- defaultResponseMessages(Map<RequestMethod, List<ResponseMessage>>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
-
Deprecated.
- defaultResponses() - Method in class springfox.documentation.spi.service.contexts.Defaults
-
Default response messages set on all api operations
- defaultResponses(Map<HttpMethod, List<Response>>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
- DefaultResponseTypeReader - Class in springfox.documentation.spring.web.plugins
- DefaultResponseTypeReader() - Constructor for class springfox.documentation.spring.web.plugins.DefaultResponseTypeReader
- defaultRules(TypeResolver) - Method in class springfox.documentation.spi.service.contexts.Defaults
- defaults() - Method in class springfox.documentation.spring.web.SpringfoxWebConfiguration
- Defaults - Class in springfox.documentation.spi.service.contexts
- Defaults() - Constructor for class springfox.documentation.spi.service.contexts.Defaults
- DefaultsProviderPlugin - Interface in springfox.documentation.spi.service
- DefaultTypeNameProvider - Class in springfox.documentation.schema
- DefaultTypeNameProvider() - Constructor for class springfox.documentation.schema.DefaultTypeNameProvider
- defaultValue(Object) - Method in class springfox.documentation.builders.PropertySpecificationBuilder
- defaultValue(String) - Method in class springfox.documentation.builders.ModelPropertyBuilder
- defaultValue(String) - Method in class springfox.documentation.builders.ParameterBuilder
-
Deprecated.Updates the default value of the parameter
- defaultValue(String) - Method in class springfox.documentation.builders.ServerVariableBuilder
- defaultValue(String) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder
-
Default value
- delegatedFactoryMethods(ResolvedType) - Method in class springfox.documentation.schema.property.FactoryMethodProvider
- dependencies(ModelContext) - Method in class springfox.documentation.schema.CachingModelProvider
- dependencies(ModelContext) - Method in class springfox.documentation.schema.DefaultModelProvider
-
Deprecated.
- dependencies(ModelContext) - Method in interface springfox.documentation.schema.ModelProvider
-
Deprecated.
- 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(Boolean) - Method in class springfox.documentation.builders.ModelFacetsBuilder
- deprecated(Boolean) - Method in class springfox.documentation.builders.PropertySpecificationBuilder
- deprecated(Boolean) - Method in class springfox.documentation.builders.RequestParameterBuilder
- deprecated(String) - Method in class springfox.documentation.builders.OperationBuilder
-
Marks the listing as deprecated
- description() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
- 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.ExampleBuilder
- description(String) - Method in class springfox.documentation.builders.ExternalDocumentationBuilder
- description(String) - Method in class springfox.documentation.builders.HttpAuthenticationBuilder
- description(String) - Method in class springfox.documentation.builders.ModelBuilder
-
Deprecated.Update the description of the model
- description(String) - Method in class springfox.documentation.builders.ModelFacetsBuilder
- description(String) - Method in class springfox.documentation.builders.ModelPropertyBuilder
- description(String) - Method in class springfox.documentation.builders.OAuth2SchemeBuilder
- description(String) - Method in class springfox.documentation.builders.OpenIdConnectSchemeBuilder
- description(String) - Method in class springfox.documentation.builders.ParameterBuilder
-
Deprecated.Updates the description of the parameter
- description(String) - Method in class springfox.documentation.builders.PropertySpecificationBuilder
- description(String) - Method in class springfox.documentation.builders.RequestParameterBuilder
- description(String) - Method in class springfox.documentation.builders.ResponseBuilder
- description(String) - Method in class springfox.documentation.builders.ServerBuilder
- description(String) - Method in class springfox.documentation.builders.ServerVariableBuilder
- description(RequestHandler) - Method in class springfox.documentation.spring.web.scanners.ApiDescriptionLookup
- descriptionResolver(Environment) - Method in class springfox.documentation.spring.web.SpringfoxWebConfiguration
- DescriptionResolver - Class in springfox.documentation.spring.web
- DescriptionResolver(Environment) - Constructor for class springfox.documentation.spring.web.DescriptionResolver
- 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.CompoundModelSpecificationBuilder
-
Inheritance discriminator
- discriminator(String) - Method in class springfox.documentation.builders.ModelBuilder
-
Deprecated.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(DocExpansion) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
- DocExpansion - Enum in springfox.documentation.swagger.web
- 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<Server>, ExternalDocumentation, 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() - Method in class springfox.documentation.spi.service.contexts.PathContext
- DocumentationContext - Class in springfox.documentation.spi.service.contexts
- DocumentationContext(DocumentationType, List<RequestHandler>, ApiInfo, String, ApiSelector, Set<Class>, Map<RequestMethod, List<ResponseMessage>>, List<Parameter>, List<RequestParameter>, Map<HttpMethod, List<Response>>, PathProvider, List<SecurityContext>, List<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>, List<Server>) - Constructor for class springfox.documentation.spi.service.contexts.DocumentationContext
- 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
inSmartLifecycle
. - DocumentationPluginsBootstrapper(DocumentationPluginsManager, List<RequestHandlerProvider>, DocumentationCache, ApiDocumentationScanner, TypeResolver, Defaults, PathProvider, Environment) - Constructor for class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
- DocumentationPluginsManager - Class in springfox.documentation.spring.web.plugins
- DocumentationPluginsManager() - Constructor for class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
- DocumentationReference - Class in springfox.documentation.service
- DocumentationReference(String, String, List<VendorExtension>) - Constructor for class springfox.documentation.service.DocumentationReference
- DocumentationType - Class in springfox.documentation.spi
- DocumentationType(String, String) - Constructor for class springfox.documentation.spi.DocumentationType
- DocumentationType(String, String, MediaType) - Constructor for class springfox.documentation.spi.DocumentationType
-
Creates a new instance of
SimplePluginMetadata
. - doHash(RequestMappingContext) - Method in class springfox.documentation.spring.web.OperationCachingEquivalence
- DOUBLE - Static variable in class springfox.documentation.schema.ScalarType
E
- Either<L,R> - Class in springfox.documentation.common
- Either(L) - Constructor for class springfox.documentation.common.Either
- Either(L, R) - Constructor for class springfox.documentation.common.Either
- elementFacet(Class<T>) - Method in interface springfox.documentation.schema.ElementFacetSource
- elementFacet(Class<T>) - Method in class springfox.documentation.schema.ModelFacets
- elementFacet(Class<T>) - Method in class springfox.documentation.schema.PropertySpecification
- ElementFacet - Interface in springfox.documentation.schema
- ElementFacetBuilder - Interface in springfox.documentation.builders
- ElementFacets - Class in springfox.documentation.builders
- ElementFacetSource - Interface in springfox.documentation.schema
- EMAIL - Static variable in class springfox.documentation.schema.ScalarType
- embeddedCollectionProvider(TypeResolver, LinkRelationProvider, TypeNameExtractor, EnumTypeDeterminer) - 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(String) - Static method in class springfox.documentation.builders.BuilderDefaults
- 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.
- enableCsrfSupport(Boolean) - Method in class springfox.documentation.swagger.web.SecurityConfigurationBuilder
- EnableOpenApi - Annotation Type in springfox.documentation.oas.annotations
-
Indicates that Swagger support should be enabled.
- EnableSwagger - Annotation Type in springfox.documentation.swagger1.annotations
-
Indicates that Swagger support should be enabled.
- EnableSwagger2 - Annotation Type in springfox.documentation.swagger2.annotations
-
Indicates that Swagger support should be enabled.
- EnableSwagger2WebFlux - Annotation Type in springfox.documentation.swagger2.annotations
-
Deprecated.
- EnableSwagger2WebMvc - Annotation Type in springfox.documentation.swagger2.annotations
-
Deprecated.
- 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
- encoding(String) - Method in class springfox.documentation.builders.RepresentationBuilder
- Encoding - Class in springfox.documentation.service
- Encoding(String, String, ParameterStyle, Boolean, Boolean, Set<Header>, Collection<VendorExtension>) - Constructor for class springfox.documentation.service.Encoding
- EncodingBuilder - Class in springfox.documentation.builders
- EncodingBuilder() - Constructor for class springfox.documentation.builders.EncodingBuilder
- encodingStyle(ParameterStyle) - Method in class springfox.documentation.oas.mappers.StyleEnumMapper
- 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
- EnumerationElementFacetBuilder - Class in springfox.documentation.builders
- EnumerationElementFacetBuilder() - Constructor for class springfox.documentation.builders.EnumerationElementFacetBuilder
- enumerationFacet(Consumer<EnumerationElementFacetBuilder>) - Method in class springfox.documentation.builders.ModelFacetsBuilder
- enumerationFacet(Consumer<EnumerationElementFacetBuilder>) - Method in class springfox.documentation.builders.PropertySpecificationBuilder
- enumerationFacet(Consumer<EnumerationElementFacetBuilder>) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder
-
Provides consumer to help build enumeration element facet
- EnumerationFacet - Class in springfox.documentation.schema
- EnumerationFacet(Collection<String>) - Constructor for class springfox.documentation.schema.EnumerationFacet
- EnumMapper - Class in springfox.documentation.swagger2.mappers
- Enums - Class in springfox.documentation.schema
- EnumTypeDeterminer - Interface in springfox.documentation.spi.schema
- equals(Object) - Method in class springfox.documentation.common.Compatibility
- equals(Object) - Method in class springfox.documentation.common.Either
- equals(Object) - Method in class springfox.documentation.common.ExternalDocumentation
- equals(Object) - Method in class springfox.documentation.common.Version
- equals(Object) - Method in class springfox.documentation.oas.mappers.MapSchema
- equals(Object) - Method in class springfox.documentation.RequestHandlerKey
- equals(Object) - Method in class springfox.documentation.schema.CollectionElementFacet
- equals(Object) - Method in class springfox.documentation.schema.CollectionSpecification
- equals(Object) - Method in class springfox.documentation.schema.CompoundModelSpecification
- equals(Object) - Method in class springfox.documentation.schema.EnumerationFacet
- equals(Object) - Method in class springfox.documentation.schema.Example
- equals(Object) - Method in class springfox.documentation.schema.MapSpecification
- equals(Object) - Method in class springfox.documentation.schema.ModelFacets
- equals(Object) - Method in class springfox.documentation.schema.ModelKey
- equals(Object) - Method in class springfox.documentation.schema.ModelProperty
-
Deprecated.
- equals(Object) - Method in class springfox.documentation.schema.ModelRef
-
Deprecated.
- equals(Object) - Method in class springfox.documentation.schema.ModelSpecification
- equals(Object) - Method in class springfox.documentation.schema.NumericElementFacet
- equals(Object) - Method in class springfox.documentation.schema.PropertySpecification
- equals(Object) - Method in class springfox.documentation.schema.QualifiedModelName
- equals(Object) - Method in class springfox.documentation.schema.ReferenceModelSpecification
- equals(Object) - Method in class springfox.documentation.schema.ScalarModelSpecification
- equals(Object) - Method in class springfox.documentation.schema.ScalarType
- equals(Object) - Method in class springfox.documentation.schema.StringElementFacet
- equals(Object) - Method in class springfox.documentation.schema.Xml
- equals(Object) - Method in class springfox.documentation.service.AllowableListValues
- equals(Object) - Method in class springfox.documentation.service.AllowableRangeValues
- equals(Object) - Method in class springfox.documentation.service.ApiDescription
- equals(Object) - Method in class springfox.documentation.service.CollectionFormat
- equals(Object) - Method in class springfox.documentation.service.ContentSpecification
- equals(Object) - Method in class springfox.documentation.service.DocumentationReference
- equals(Object) - Method in class springfox.documentation.service.Encoding
- equals(Object) - Method in class springfox.documentation.service.Header
- equals(Object) - Method in class springfox.documentation.service.ListVendorExtension
- equals(Object) - Method in class springfox.documentation.service.ObjectVendorExtension
- equals(Object) - Method in class springfox.documentation.service.ParameterSpecification
- equals(Object) - Method in class springfox.documentation.service.Representation
- equals(Object) - Method in class springfox.documentation.service.RequestParameter
- equals(Object) - Method in class springfox.documentation.service.ResourceGroup
- equals(Object) - Method in class springfox.documentation.service.Response
- equals(Object) - Method in class springfox.documentation.service.ResponseMessage
-
Deprecated.
- equals(Object) - Method in class springfox.documentation.service.Server
- equals(Object) - Method in class springfox.documentation.service.ServerVariable
- equals(Object) - Method in class springfox.documentation.service.SimpleParameterSpecification
- 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.scanners.ComparisonCondition
- 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
- equalsIgnoringName(Object) - Method in class springfox.documentation.schema.Model
-
Deprecated.
- exactMatch(ResolvedType, ResolvedType) - Static method in class springfox.documentation.schema.WildcardType
- example() - Method in class springfox.documentation.schema.property.BaseModelProperty
- example(Object) - Method in class springfox.documentation.builders.ModelBuilder
-
Deprecated.Updates the Example for the model
- example(Object) - Method in class springfox.documentation.builders.ModelPropertyBuilder
-
Updates the example
- example(Object) - Method in class springfox.documentation.builders.PropertySpecificationBuilder
- example(Example) - Method in class springfox.documentation.builders.RequestParameterBuilder
- Example - Class in springfox.documentation.schema
- Example(Object) - Constructor for class springfox.documentation.schema.Example
-
Deprecated.
- Example(String, Object) - Constructor for class springfox.documentation.schema.Example
-
Deprecated.
- Example(String, String, String, Object, String, String) - Constructor for class springfox.documentation.schema.Example
- EXAMPLE - springfox.documentation.swagger.web.ModelRendering
- ExampleBuilder - Class in springfox.documentation.builders
- ExampleBuilder() - Constructor for class springfox.documentation.builders.ExampleBuilder
- examples(Example) - Static method in class springfox.documentation.swagger.readers.parameter.Examples
- examples(String, ExampleObject[]) - Static method in class springfox.documentation.swagger.readers.parameter.Examples
- examples(Collection<Example>) - Method in class springfox.documentation.builders.RequestParameterBuilder
- examples(Collection<Example>) - Method in class springfox.documentation.builders.ResponseBuilder
- examples(List<Example>) - Method in class springfox.documentation.builders.ModelFacetsBuilder
- examples(List<Example>) - Method in class springfox.documentation.builders.ResponseMessageBuilder
-
Deprecated.Updates the response examples
- Examples - Class in springfox.documentation.swagger.readers.parameter
- ExamplesMapper - Class in springfox.documentation.swagger2.mappers
- ExamplesMapper - Interface in springfox.documentation.oas.mappers
- ExamplesMapper() - Constructor for class springfox.documentation.swagger2.mappers.ExamplesMapper
- exclusiveMaximum(Boolean) - Method in class springfox.documentation.schema.NumericElementFacetBuilder
- exclusiveMinimum(Boolean) - Method in class springfox.documentation.schema.NumericElementFacetBuilder
- 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
- ExpandedParameterNotBlankAnnotationPlugin - Class in springfox.bean.validators.plugins.parameter
- ExpandedParameterNotBlankAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.parameter.ExpandedParameterNotBlankAnnotationPlugin
- 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
- expanderNotBlank() - 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
- explode(Boolean) - Method in class springfox.documentation.builders.EncodingBuilder
- explode(Boolean) - Method in class springfox.documentation.builders.ParameterBuilder
-
Deprecated.
- explode(Boolean) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder
-
Use this if we want to explode collections
- extensions(Collection<VendorExtension>) - Method in class springfox.documentation.builders.ExternalDocumentationBuilder
- extensions(Collection<VendorExtension>) - Method in class springfox.documentation.builders.ServerBuilder
- 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.HttpAuthenticationBuilder
- extensions(List<VendorExtension>) - Method in class springfox.documentation.builders.ModelFacetsBuilder
- extensions(List<VendorExtension>) - Method in class springfox.documentation.builders.ModelPropertyBuilder
- extensions(List<VendorExtension>) - Method in class springfox.documentation.builders.OAuth2SchemeBuilder
- extensions(List<VendorExtension>) - Method in class springfox.documentation.builders.OpenIdConnectSchemeBuilder
- extensions(List<VendorExtension>) - Method in class springfox.documentation.builders.OperationBuilder
-
Updates the operation extensions
- extensions(List<VendorExtension>) - Method in class springfox.documentation.builders.RequestParameterBuilder
- extensions(List<VendorExtension>) - Method in class springfox.documentation.builders.ServerVariableBuilder
- extensions(List<VendorExtension>) - Method in class springfox.documentation.spring.web.plugins.Docket
-
Add to the api's vendor extensions
- externalDocumentation(Consumer<ExternalDocumentationBuilder>) - Method in class springfox.documentation.builders.DocumentationBuilder
-
Adds external documentation information for this API
- externalDocumentation(ExternalDocumentation) - Method in class springfox.documentation.builders.ModelFacetsBuilder
- externalDocumentation(ExternalDocumentation) - Method in class springfox.documentation.builders.OperationBuilder
- ExternalDocumentation - Class in springfox.documentation.common
- ExternalDocumentation(String, String, Collection<VendorExtension>) - Constructor for class springfox.documentation.common.ExternalDocumentation
- ExternalDocumentationBuilder - Class in springfox.documentation.builders
- ExternalDocumentationBuilder() - Constructor for class springfox.documentation.builders.ExternalDocumentationBuilder
- externalValue(String) - Method in class springfox.documentation.builders.ExampleBuilder
- 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
- facetBuilder() - Method in class springfox.documentation.schema.CollectionElementFacet
- facetBuilder() - Method in interface springfox.documentation.schema.ElementFacet
- facetBuilder() - Method in class springfox.documentation.schema.EnumerationFacet
- facetBuilder() - Method in class springfox.documentation.schema.NumericElementFacet
- facetBuilder() - Method in class springfox.documentation.schema.StringElementFacet
- facetBuilder(Class<T>) - Method in class springfox.documentation.builders.PropertySpecificationBuilder
- facetOfType(Class<T>) - Method in class springfox.documentation.service.SimpleParameterSpecification
- facets(Consumer<ModelFacetsBuilder>) - Method in class springfox.documentation.builders.ModelSpecificationBuilder
-
Provides a consumer to build facets
- 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<A>) - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
- findAnnotation(Class<A>) - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterMetadataAccessor
- findAnnotation(Class<T>) - Method in interface springfox.documentation.RequestHandler
- findAnnotation(Class<T>) - Method in class springfox.documentation.service.ResolvedMethodParameter
- findAnnotation(Class<T>) - Method in class springfox.documentation.spi.service.contexts.OperationContext
- 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<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
- findAnnotation(AnnotatedElement, Class<T>) - Static method in class springfox.documentation.schema.property.JacksonXmlPropertyPlugin
- findAnnotation(AnnotatedElement, Class<T>) - Static method in class springfox.documentation.schema.property.XmlPropertyPlugin
- 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.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
- 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.
- firstPathSegment(String) - Static method in class springfox.documentation.spring.web.paths.Paths
- flippedResponse() - Method in class springfox.documentation.schema.ModelKey
- FLOAT - Static variable in class springfox.documentation.schema.ScalarType
- 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
-
Deprecated.
- FORM - springfox.documentation.service.ParameterStyle
- FORM - springfox.documentation.service.ParameterType
- FORMDATA - springfox.documentation.service.ParameterType
- FormParameterSpecificationProvider - Class in springfox.documentation.builders
- FormParameterSpecificationProvider() - Constructor for class springfox.documentation.builders.FormParameterSpecificationProvider
- forPaths(Predicate<String>) - Method in class springfox.documentation.spi.service.contexts.SecurityContextBuilder
-
Deprecated.
- from(String) - Static method in enum springfox.documentation.service.ParameterType
- from(String, String) - Static method in class springfox.documentation.schema.ScalarType
- 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
- from(AllowableRangeValues) - Method in class springfox.documentation.schema.NumericElementFacetBuilder
- from(AllowableValues) - Static method in class springfox.documentation.builders.EnumerationElementFacetBuilder
- fromApiResponsesAnnotation() - Static method in class springfox.documentation.swagger.annotations.Annotations
- fromEncodings(Collection<Encoding>, ModelNamesRegistry) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- fromHeaders(Collection<Header>, ModelNamesRegistry) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- fromHierarchy(MethodParameter, Class<A>) - Static method in class springfox.documentation.swagger.readers.parameter.ParameterAnnotationReader
- fromModel(ModelSpecification, ModelNamesRegistry) - Method in class springfox.documentation.swagger2.mappers.PropertyMapper
- fromOperationAnnotation() - Static method in class springfox.documentation.swagger.annotations.Annotations
- fromParent(ModelContext, ResolvedType) - Static method in class springfox.documentation.spi.schema.contexts.ModelContext
-
Convenience method to provide an new context for an input parameter
- fromProperty(PropertySpecification, ModelNamesRegistry) - Method in class springfox.documentation.swagger2.mappers.PropertyMapper
- fromRepresentation(Representation, ModelNamesRegistry) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- fromSimpleParameter(Optional<SimpleParameterSpecification>, ModelNamesRegistry) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- FULL - springfox.documentation.swagger.web.DocExpansion
- 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
- 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
- getAccepts() - Method in class springfox.documentation.builders.ParameterSpecificationContext
- 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
-
Deprecated.
- getAllowableValues() - Method in class springfox.documentation.schema.ModelRef
-
Deprecated.
- getAllowableValues() - Method in interface springfox.documentation.schema.ModelReference
-
Deprecated.
- getAllowableValues() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- getAllowableValues() - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
- getAllowableValues() - Method in class springfox.documentation.swagger1.dto.Parameter
- getAllowedValues() - Method in class springfox.documentation.schema.EnumerationFacet
- getAllowedValues() - Method in class springfox.documentation.service.ServerVariable
- getAllowEmptyValue() - Method in class springfox.documentation.schema.PropertySpecification
- getAllowEmptyValue() - Method in class springfox.documentation.service.SimpleParameterSpecification
- getAllowMultiple() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- getAllowReserved() - Method in class springfox.documentation.service.Encoding
- getAllowReserved() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- getAllowReserved() - Method in class springfox.documentation.service.SimpleParameterSpecification
- getAlternate() - Method in class springfox.documentation.schema.AlternateTypeRule
- getAlternateTypeProvider() - Method in class springfox.documentation.schema.property.BaseModelProperty
- 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
- getAlternateTypeProvider() - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext
- 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.
- getApiKeyName() - Method in class springfox.documentation.swagger.web.SecurityConfiguration
-
Deprecated.
- getApiKeyVehicle() - Method in class springfox.documentation.swagger.web.SecurityConfiguration
-
Deprecated.
- 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
- 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
- getAuthorizationUrl() - Method in class springfox.documentation.service.OAuth2Scheme
- getBaseModel() - Method in class springfox.documentation.schema.Model
-
Deprecated.
- 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
- getBaseUrl() - Method in class springfox.boot.starter.autoconfigure.SpringfoxConfigurationProperties.SwaggerUiConfigurationProperties
- getBeanPropertyDefinition() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext
- getBearerFormat() - Method in class springfox.documentation.service.HttpAuthenticationScheme
- getBody() - Method in class springfox.documentation.service.Operation
- getBuilder() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
-
Deprecated.
- getBuilder() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext
-
Deprecated.Use
ModelPropertyContext.getSpecificationBuilder()
instead - getCircleParameters(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext
- getCircles() - Method in class springfox.documentation.spring.web.scanners.MergingContext
- getClassName() - Method in class springfox.documentation.common.ClassNotPresentInClassPathCondition
- getClassName() - Method in class springfox.documentation.common.ClassPresentInClassPathCondition
- getClassName() - Method in class springfox.documentation.schema.JacksonXmlPresentInClassPathCondition
- getClassName() - Method in class springfox.documentation.schema.JaxbPresentInClassPathCondition
- getClassName() - Method in class springfox.documentation.spring.web.OnNotServletBasedWebApplication
- getClassName() - Method in class springfox.documentation.spring.web.OnReactiveWebApplication
- getClassName() - Method in class springfox.documentation.spring.web.OnServletBasedWebApplication
- 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.Response
- getCode() - Method in class springfox.documentation.service.ResponseMessage
-
Deprecated.
- getCode() - Method in class springfox.documentation.swagger1.dto.ResponseMessage
- getCollection() - Method in class springfox.documentation.schema.ModelSpecification
- getCollectionFormat() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- getCollectionFormat() - Method in class springfox.documentation.service.SimpleParameterSpecification
- getCollectionType() - Method in class springfox.documentation.schema.CollectionSpecification
- getCombiner() - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
- getComparisonCondition(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext
- getCompound() - Method in class springfox.documentation.schema.ModelSpecification
- getConditions() - Method in class springfox.documentation.spring.web.scanners.ComparisonCondition
- 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
- getContent() - Method in class springfox.documentation.service.ParameterSpecification
- getContentParameter() - Method in class springfox.documentation.builders.ParameterSpecificationContext
- getContentSpecificationBuilder() - Method in class springfox.documentation.builders.ParameterSpecificationContext
- getContentType() - Method in class springfox.documentation.service.Encoding
- 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
- getDefaultConfiguration() - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
- 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
-
Deprecated.
- getDefaultValue() - Method in class springfox.documentation.schema.PropertySpecification
- getDefaultValue() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- getDefaultValue() - Method in class springfox.documentation.service.ServerVariable
- getDefaultValue() - Method in class springfox.documentation.service.SimpleParameterSpecification
- getDefaultValue() - Method in class springfox.documentation.swagger1.dto.Parameter
- getDeprecated() - Method in class springfox.documentation.schema.ModelFacets
- getDeprecated() - Method in class springfox.documentation.schema.PropertySpecification
- getDeprecated() - Method in class springfox.documentation.service.Operation
- getDeprecated() - Method in class springfox.documentation.service.RequestParameter
- getDeprecated() - Method in class springfox.documentation.swagger1.dto.Operation
- getDescription() - Method in class springfox.documentation.common.ExternalDocumentation
- getDescription() - Method in class springfox.documentation.schema.Example
- getDescription() - Method in class springfox.documentation.schema.Model
-
Deprecated.
- getDescription() - Method in class springfox.documentation.schema.ModelFacets
- getDescription() - Method in class springfox.documentation.schema.ModelProperty
-
Deprecated.
- getDescription() - Method in class springfox.documentation.schema.PropertySpecification
- 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.CollectionFormat
- getDescription() - Method in class springfox.documentation.service.DocumentationReference
- getDescription() - Method in class springfox.documentation.service.Header
- getDescription() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- getDescription() - Method in class springfox.documentation.service.RequestBody
- getDescription() - Method in class springfox.documentation.service.RequestParameter
- getDescription() - Method in class springfox.documentation.service.Response
- getDescription() - Method in class springfox.documentation.service.SecurityScheme
- getDescription() - Method in class springfox.documentation.service.Server
- getDescription() - Method in class springfox.documentation.service.ServerVariable
- 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.CompoundModelSpecification
- getDiscriminator() - Method in class springfox.documentation.schema.Model
-
Deprecated.
- 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, HttpServletRequest) - Method in class springfox.documentation.oas.web.OpenApiControllerWebMvc
- getDocumentation(String, HttpServletRequest) - Method in class springfox.documentation.swagger2.web.Swagger2ControllerWebMvc
- getDocumentation(String, ServerHttpRequest) - Method in class springfox.documentation.oas.web.OpenApiControllerWebFlux
- getDocumentation(String, ServerHttpRequest) - Method in class springfox.documentation.swagger2.web.Swagger2ControllerWebFlux
- 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.spi.service.contexts.ResponseContext
- getDocumentationContext() - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext
- getDocumentationContext() - Method in class springfox.documentation.spring.web.scanners.ApiListingScanningContext
- getDocumentationPath() - Method in class springfox.documentation.spring.web.paths.DefaultPathProvider
-
The base path to the swagger api documentation.
- getDocumentationPluginsManager() - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
- getDocumentationType() - Method in class springfox.documentation.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 class springfox.documentation.spi.service.contexts.ResponseContext
- 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.readers.parameter.ExpansionContext
- getDocumentationType() - Method in class springfox.documentation.spring.web.scanners.ApiListingScanningContext
- getEmail() - Method in class springfox.documentation.service.Contact
- getEnableCsrfSupport() - Method in class springfox.documentation.swagger.web.SecurityConfiguration
- getEncodings() - Method in class springfox.documentation.service.Representation
- getEntityContext() - Method in class springfox.documentation.spring.data.rest.EntityAssociationContext
- getEntityExtractors() - Method in interface springfox.documentation.spring.data.rest.RequestHandlerExtractorConfiguration
- getEnumTypeDeterminer() - Method in class springfox.documentation.schema.property.ModelSpecificationFactory
- getExample() - Method in class springfox.documentation.schema.Model
-
Deprecated.
- getExample() - Method in class springfox.documentation.schema.ModelProperty
-
Deprecated.
- getExample() - Method in class springfox.documentation.schema.PropertySpecification
- getExamples() - Method in class springfox.documentation.schema.ModelFacets
- getExamples() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- getExamples() - Method in class springfox.documentation.service.RequestParameter
- getExamples() - Method in class springfox.documentation.service.Response
- getExamples() - Method in class springfox.documentation.service.ResponseMessage
-
Deprecated.
- getExclusiveMax() - Method in class springfox.documentation.service.AllowableRangeValues
- getExclusiveMaximum() - Method in class springfox.documentation.schema.NumericElementFacet
- getExclusiveMin() - Method in class springfox.documentation.service.AllowableRangeValues
- getExclusiveMinimum() - Method in class springfox.documentation.schema.NumericElementFacet
- getExplode() - Method in class springfox.documentation.service.Encoding
- getExplode() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- getExplode() - Method in class springfox.documentation.service.SimpleParameterSpecification
- getExtensions() - Method in class springfox.documentation.common.ExternalDocumentation
- getExtensions() - Method in class springfox.documentation.schema.Example
- getExtensions() - Method in class springfox.documentation.schema.ModelFacets
- getExtensions() - Method in class springfox.documentation.service.DocumentationReference
- getExtensions() - Method in class springfox.documentation.service.Encoding
- getExtensions() - Method in class springfox.documentation.service.RequestBody
- getExtensions() - Method in class springfox.documentation.service.RequestParameter
- getExtensions() - Method in class springfox.documentation.service.Server
- getExtensions() - Method in class springfox.documentation.service.ServerVariable
- getExternalDocumentation() - Method in class springfox.documentation.schema.ModelFacets
- getExternalDocumentation() - Method in class springfox.documentation.service.Documentation
- getExternalDocumentation() - Method in class springfox.documentation.service.Operation
- getExternalValue() - Method in class springfox.documentation.schema.Example
- getFacetExamples() - Method in class springfox.documentation.schema.ModelSpecification
- getFacetExtensions() - Method in class springfox.documentation.schema.ModelSpecification
- getFacets() - Method in class springfox.documentation.schema.ModelFacets
- getFacets() - Method in class springfox.documentation.schema.ModelSpecification
- getFacets() - Method in class springfox.documentation.schema.PropertySpecification
- getFacets() - Method in class springfox.documentation.service.SimpleParameterSpecification
- getField() - Method in class springfox.documentation.builders.ValidationResult
- getField() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
-
Deprecated.
- 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
- getFlowType() - Method in class springfox.documentation.service.OAuth2Scheme
- getFormat() - Method in class springfox.documentation.schema.ScalarType
- 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
-
Deprecated.
- getGlobalParameters() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
- getGlobalRequestParameters() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
-
Deprecated.use @see
DocumentationContext.getGlobalParameters()
instead - getGlobalRequestParameters() - Method in class springfox.documentation.spi.service.contexts.OperationContext
- 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 class springfox.documentation.spi.service.contexts.ResponseContext
- 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
- getHandlerProviders() - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
- getHeaders() - Method in class springfox.documentation.service.Encoding
- getHeaders() - Method in class springfox.documentation.service.Response
- getHeaders() - Method in class springfox.documentation.service.ResponseMessage
-
Deprecated.
- getHidden() - Method in class springfox.documentation.schema.PropertySpecification
- getHidden() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- getHidden() - Method in class springfox.documentation.service.RequestParameter
- getHost() - Method in class springfox.boot.starter.autoconfigure.SpringfoxConfigurationProperties.Swagger2Configuration
- 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.Example
- getId() - Method in class springfox.documentation.schema.Model
-
Deprecated.
- getId() - Method in class springfox.documentation.spring.web.SpringfoxTemplateFormat
- getId() - Method in class springfox.documentation.swagger1.dto.ModelDto
- 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
- getIn() - Method in class springfox.documentation.builders.ParameterSpecificationContext
- getIn() - Method in enum springfox.documentation.service.ParameterType
- getIn() - Method in class springfox.documentation.service.RequestParameter
- 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
-
Deprecated.
- getItemType() - Method in interface springfox.documentation.schema.ModelReference
-
Deprecated.
- getKey() - Method in class springfox.documentation.schema.Entry
- getKey() - Method in class springfox.documentation.schema.MapSpecification
- getKey() - Method in class springfox.documentation.schema.ReferenceModelSpecification
- getKeyname() - Method in class springfox.documentation.service.ApiKey
- getKeyname() - Method in class springfox.documentation.swagger1.dto.ApiKey
- getKnownModels() - Method in class springfox.documentation.spi.service.contexts.OperationContext
- getLeft() - Method in class springfox.documentation.common.Either
- getLegacy() - Method in class springfox.documentation.common.Compatibility
- getLevel() - Method in class springfox.documentation.builders.ValidationResult
- 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.
- getLoginEndpoint() - Method in class springfox.documentation.service.ImplicitGrant
- getLoginEndpoint() - Method in class springfox.documentation.swagger1.dto.ImplicitGrant
- getMap() - Method in class springfox.documentation.schema.ModelSpecification
- 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
- getMaximum() - Method in class springfox.documentation.schema.NumericElementFacet
- getMaxItems() - Method in class springfox.documentation.schema.CollectionElementFacet
- getMaxLength() - Method in class springfox.documentation.schema.StringElementFacet
- getMaxProperties() - Method in class springfox.documentation.schema.CompoundModelSpecification
- getMediaType() - Method in class springfox.documentation.schema.Example
- getMediaType() - Method in class springfox.documentation.service.Representation
- getMediaType() - Method in class springfox.documentation.spi.DocumentationType
- getMessage() - Method in class springfox.documentation.builders.ValidationResult
- getMessage() - Method in class springfox.documentation.service.ResponseMessage
-
Deprecated.
- 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
- getMin() - Method in class springfox.documentation.service.AllowableRangeValues
- getMin() - Method in class springfox.documentation.swagger1.dto.AllowableRangeValues
- getMinimum() - Method in class springfox.documentation.schema.NumericElementFacet
- getMinItems() - Method in class springfox.documentation.schema.CollectionElementFacet
- getMinLength() - Method in class springfox.documentation.schema.StringElementFacet
- getMinProperties() - Method in class springfox.documentation.schema.CompoundModelSpecification
- getModel() - Method in class springfox.documentation.schema.CollectionSpecification
- getModel() - Method in class springfox.documentation.service.Representation
- getModel() - Method in class springfox.documentation.service.SimpleParameterSpecification
- getModel(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext
- getModelContext(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext
- getModelFor() - Method in class springfox.documentation.spring.web.scanners.ComparisonCondition
- getModelId() - Method in class springfox.documentation.schema.ModelRef
-
Deprecated.
- getModelId() - Method in interface springfox.documentation.schema.ModelReference
-
Deprecated.
- getModelId() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
- getModelKey() - Method in class springfox.documentation.schema.CompoundModelSpecification
- getModelMap() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
- getModelNamesRegistry() - Method in class springfox.documentation.service.ApiListing
- getModelParameter(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext
- getModelRef() - Method in class springfox.documentation.schema.ModelProperty
-
Deprecated.
- getModelRef() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- 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
- getModelSpecification() - Method in class springfox.documentation.service.Header
- getModelSpecificationBuilder() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
- getModelSpecifications() - Method in class springfox.documentation.service.ApiListing
- getModelsTo() - Method in class springfox.documentation.spring.web.scanners.ComparisonCondition
- getModern() - Method in class springfox.documentation.common.Compatibility
- getMultipleOf() - Method in class springfox.documentation.schema.NumericElementFacet
- getName() - Method in class springfox.documentation.builders.ParameterSpecificationContext
- getName() - Method in interface springfox.documentation.RequestHandler
- getName() - Method in class springfox.documentation.schema.Model
-
Deprecated.
- getName() - Method in class springfox.documentation.schema.ModelProperty
-
Deprecated.
- getName() - Method in class springfox.documentation.schema.ModelSpecification
- 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.PropertySpecification
- getName() - Method in class springfox.documentation.schema.QualifiedModelName
- 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
-
Deprecated.
- getName() - Method in class springfox.documentation.service.RequestParameter
- getName() - Method in class springfox.documentation.service.SecurityScheme
- getName() - Method in class springfox.documentation.service.Server
- getName() - Method in class springfox.documentation.service.ServerVariable
- 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
- getNames() - Method in class springfox.documentation.schema.TypeNameIndexingAdapter
- getNames() - Method in interface springfox.documentation.spi.schema.UniqueTypeNameAdapter
-
Provides information about model names
- getNamespace() - Method in class springfox.documentation.schema.QualifiedModelName
- 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
- getNullable() - Method in class springfox.documentation.schema.ModelFacets
- getNullable() - Method in class springfox.documentation.schema.PropertySpecification
- getObject() - Method in class springfox.documentation.builders.ValidationResult
- getObjectMapper() - Method in class springfox.documentation.schema.configuration.ObjectMapperConfigured
- getOpenApi() - Method in class springfox.boot.starter.autoconfigure.SpringfoxConfigurationProperties
- 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
- getOpenIdConnectUrl() - Method in class springfox.documentation.service.OpenIdConnectScheme
- getOperationContext() - Method in class springfox.documentation.spi.service.contexts.ParameterContext
- getOperationContext() - Method in class springfox.documentation.spi.service.contexts.ResponseContext
- 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.Operation
- getOrder() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- getOrder() - Method in class springfox.documentation.service.Tag
- getOrder() - Method in class springfox.documentation.spring.web.plugins.JacksonSerializerConvention
- getOriginal() - Method in class springfox.documentation.schema.AlternateTypeRule
- getOriginalInfo() - Method in class springfox.documentation.spring.web.WebMvcRequestMappingInfoWrapper
- getOriginalInfo() - Method in interface springfox.documentation.spring.wrapper.RequestMappingInfo
- getOwner() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext
-
Owning model context
- getParamAccess() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- getParamAccess() - Method in class springfox.documentation.swagger1.dto.Parameter
- getParameterBuilder() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
- getParameterId() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
- getParameterId() - Method in class springfox.documentation.spring.web.scanners.MergingContext
- getParameterIndex() - Method in class springfox.documentation.service.RequestParameter
- 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() - 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
- getParameters(Set<NameValueExpression<String>>, String) - Method in class springfox.documentation.spring.web.readers.operation.AbstractOperationParameterRequestConditionReader
- getParameters(BaseHttpInboundEndpoint) - Method in class springfox.documentation.spring.web.plugins.SpringIntegrationParametersProvider
- getParameterSpecification() - Method in class springfox.documentation.service.RequestParameter
- 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
-
Deprecated.
- 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
- 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
-
Deprecated.
- getPattern() - Method in class springfox.documentation.schema.StringElementFacet
- getPattern() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- 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
- getPhase() - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
- getPluginsManager() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterExpander
- getPosition() - Method in class springfox.documentation.schema.ModelProperty
-
Deprecated.
- getPosition() - Method in class springfox.documentation.schema.PropertySpecification
- 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
- getPrecedence() - Method in class springfox.documentation.service.RequestParameter
- 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.CompoundModelSpecification
- getProperties() - Method in class springfox.documentation.schema.Model
-
Deprecated.
- getProperties() - Method in class springfox.documentation.swagger1.dto.ModelDto
- getPropertyRef() - Method in class springfox.documentation.service.Encoding
- 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
- getQualifiedModelName() - Method in class springfox.documentation.schema.ModelKey
- getQualifiedType() - Method in class springfox.documentation.schema.Model
-
Deprecated.
- getQualifiedType() - Method in class springfox.documentation.schema.ModelProperty
-
Deprecated.
- getQualifiedType() - Method in class springfox.documentation.swagger1.dto.ModelDto
- getQualifiedType() - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
- getQuery() - Method in class springfox.documentation.service.ParameterSpecification
- getQueryParameters() - Method in class springfox.documentation.service.Operation
- getReadOnly() - Method in class springfox.documentation.schema.PropertySpecification
- getRealm() - Method in class springfox.documentation.swagger.web.SecurityConfiguration
- getReference() - Method in class springfox.documentation.schema.ModelSpecification
- getReference() - Method in class springfox.documentation.service.SecurityReference
- getReference() - Method in class springfox.documentation.swagger1.dto.ReferenceDataType
- getRefreshUrl() - Method in class springfox.documentation.service.OAuth2Scheme
- getRepositoryInstance() - Method in class springfox.documentation.spring.data.rest.EntityContext
- getRepositoryMetadata() - Method in class springfox.documentation.spring.data.rest.EntityContext
- getRepresentations() - Method in class springfox.documentation.service.ContentSpecification
- getRepresentations() - Method in class springfox.documentation.service.RequestBody
- getRepresentations() - Method in class springfox.documentation.service.Response
- 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
- getRequestParameterBuilder() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext
- getRequestParameters() - Method in class springfox.documentation.service.Operation
- getRequestParameters() - Method in class springfox.documentation.spi.service.contexts.PathContext
- getRequestParameters(Set<NameValueExpression<String>>, ParameterType) - Method in class springfox.documentation.spring.web.readers.operation.AbstractOperationParameterRequestConditionReader
- getRequired() - Method in class springfox.documentation.schema.PropertySpecification
- getRequired() - Method in class springfox.documentation.service.Header
- getRequired() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- getRequired() - Method in class springfox.documentation.service.RequestBody
- getRequired() - Method in class springfox.documentation.service.RequestParameter
- getResolvedMembers() - Method in class springfox.documentation.spring.web.readers.parameter.ModelAttributeField
- getResolver() - Method in class springfox.documentation.schema.property.BaseModelProperty
- getResolver() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext
- getResourceGroup() - Method in class springfox.documentation.spi.service.contexts.ApiListingContext
- getResourceGroupRequestMappings() - Method in class springfox.documentation.spring.web.scanners.ApiListingReferenceScanResult
- getResourceListing() - Method in class springfox.documentation.service.Documentation
- getResourceListing() - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
- 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
- getResponseMessages() - Method in class springfox.documentation.service.Operation
-
Deprecated.
- getResponseMessages() - Method in class springfox.documentation.swagger1.dto.Operation
- getResponseModel() - Method in class springfox.documentation.service.Operation
-
Deprecated.
- getResponseModel() - Method in class springfox.documentation.service.ResponseMessage
-
Deprecated.
- getResponseModel() - Method in class springfox.documentation.swagger1.dto.ResponseMessage
- getResponses() - Method in class springfox.documentation.service.Operation
- 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
- getRight() - Method in class springfox.documentation.common.Either
- getRootId() - Method in class springfox.documentation.spring.web.scanners.MergingContext
- getRootModel() - Method in class springfox.documentation.spring.web.scanners.MergingContext
- getScalar() - Method in class springfox.documentation.schema.ModelSpecification
- getScalarExample() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- getScalarExample() - Method in class springfox.documentation.service.RequestParameter
- getScanned() - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
- getScheme() - Method in class springfox.documentation.service.HttpAuthenticationScheme
- 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.OAuth2Scheme
- 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
- getSecuritySchemes() - Method in class springfox.documentation.service.ResourceListing
- getSecuritySchemes() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
- getServers() - Method in class springfox.documentation.service.Documentation
- getServers() - Method in class springfox.documentation.service.ResourceListing
- getServers() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
- getShowCommonExtensions() - Method in class springfox.documentation.swagger.web.UiConfiguration
- getShowExtensions() - Method in class springfox.documentation.swagger.web.UiConfiguration
- getSimilarTypeModels(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext
- getSimpleParameter() - Method in class springfox.documentation.builders.ParameterSpecificationContext
- getSimpleParameterSpecificationBuilder() - Method in class springfox.documentation.builders.ParameterSpecificationContext
- getSpecification() - Method in class springfox.documentation.oas.web.OpenApiTransformationContext
- getSpecification() - Method in class springfox.documentation.swagger2.web.SwaggerTransformationContext
- getSpecificationBuilder() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext
-
Model property specification.
- getStyle() - Method in class springfox.documentation.service.Encoding
- getStyle() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- getStyle() - Method in class springfox.documentation.service.SimpleParameterSpecification
- getSubclassReferences() - Method in class springfox.documentation.schema.CompoundModelSpecification
- getSubTypes() - Method in class springfox.documentation.schema.Model
-
Deprecated.
- getSubTypes() - Method in class springfox.documentation.swagger1.dto.ModelDto
- getSummary() - Method in class springfox.documentation.schema.Example
- getSummary() - Method in class springfox.documentation.service.ApiDescription
- 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
- getSwagger() - Method in class springfox.boot.starter.autoconfigure.SpringfoxConfigurationProperties
- getSwaggerBaseUiUrl() - Method in class springfox.documentation.swagger.web.UiConfiguration
- getSwaggerUi() - Method in class springfox.boot.starter.autoconfigure.SpringfoxConfigurationProperties
- 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
- 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.schema.ModelFacets
- 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
- getTokenUrl() - Method in class springfox.documentation.service.OAuth2Scheme
- getType() - Method in class springfox.documentation.schema.Model
-
Deprecated.
- getType() - Method in class springfox.documentation.schema.ModelProperty
-
Deprecated.
- getType() - Method in class springfox.documentation.schema.ModelRef
-
Deprecated.
- getType() - Method in interface springfox.documentation.schema.ModelReference
-
Deprecated.
- getType() - Method in class springfox.documentation.schema.property.BaseModelProperty
- getType() - Method in interface springfox.documentation.schema.property.ModelProperty
- getType() - Method in class springfox.documentation.schema.PropertySpecification
- getType() - Method in class springfox.documentation.schema.ScalarModelSpecification
- getType() - Method in class springfox.documentation.schema.ScalarType
- getType() - Method in class springfox.documentation.service.CollectionFormat
- getType() - Method in class springfox.documentation.service.GrantType
- getType() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- 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
- getTypeConventions() - Method in class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper
- getTypeId() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
- 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
- getTypeName(String) - Method in class springfox.documentation.schema.TypeNameIndexingAdapter
- getTypeName(String) - Method in interface springfox.documentation.spi.schema.UniqueTypeNameAdapter
-
Returns type for the model
- getTypeNameExtractor() - Method in class springfox.documentation.schema.property.ModelSpecificationFactory
- getTypeResolver() - Method in class springfox.documentation.spring.data.rest.EntityContext
- getTypeSignature() - Method in class springfox.documentation.schema.ModelRef
-
Deprecated.
- getTypeSignature() - Method in interface springfox.documentation.schema.ModelReference
-
Deprecated.
- getUniqueId() - Method in class springfox.documentation.service.Operation
- getUniqueItems() - Method in class springfox.documentation.schema.CollectionElementFacet
- getUrl() - Method in class springfox.documentation.common.ExternalDocumentation
- getUrl() - Method in class springfox.documentation.service.Contact
- getUrl() - Method in class springfox.documentation.service.DocumentationReference
- getUrl() - Method in class springfox.documentation.service.LoginEndpoint
- getUrl() - Method in class springfox.documentation.service.Server
- 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
- getV2() - Method in class springfox.boot.starter.autoconfigure.SpringfoxConfigurationProperties.SwaggerConfigurationProperties
- getValidationGroupDiscriminators() - Method in class springfox.documentation.schema.ModelKey
- getValidationGroups() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
- getValidatorUrl() - Method in class springfox.documentation.swagger.web.UiConfiguration
- getValue() - Method in class springfox.documentation.schema.Example
- getValue() - Method in class springfox.documentation.schema.MapSpecification
- getValue() - Method in class springfox.documentation.service.ListVendorExtension
- getValue() - Method in class springfox.documentation.service.ObjectVendorExtension
- getValue() - Method in enum springfox.documentation.service.ParameterStyle
- 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
- getVariables() - Method in class springfox.documentation.service.Server
- getVendorExtensions() - Method in class springfox.documentation.schema.ModelProperty
-
Deprecated.
- getVendorExtensions() - Method in class springfox.documentation.schema.PropertySpecification
- 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.Parameter
-
Deprecated.
- getVendorExtensions() - Method in class springfox.documentation.service.Response
- getVendorExtensions() - Method in class springfox.documentation.service.ResponseMessage
-
Deprecated.
- getVendorExtensions() - Method in class springfox.documentation.service.SecurityScheme
- getVendorExtensions() - Method in class springfox.documentation.service.Tag
- getVendorExtentions() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- 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
- getView() - Method in class springfox.documentation.spi.schema.contexts.ModelContext
- getViewDiscriminator() - Method in class springfox.documentation.schema.ModelKey
- getWrapped() - Method in class springfox.documentation.schema.Xml
- getWriteOnly() - Method in class springfox.documentation.schema.PropertySpecification
- getXml() - Method in class springfox.documentation.schema.Model
-
Deprecated.
- getXml() - Method in class springfox.documentation.schema.ModelFacets
- getXml() - Method in class springfox.documentation.schema.ModelProperty
-
Deprecated.
- getXml() - Method in class springfox.documentation.schema.PropertySpecification
- globalOperationParameters(List<Parameter>) - Method in class springfox.documentation.spring.web.plugins.Docket
-
Deprecated.
- globalRequestParameters(List<RequestParameter>) - Method in class springfox.documentation.spring.web.plugins.Docket
-
Adds default parameters which will be applied to all operations.
- globalResponseMessage(RequestMethod, List<ResponseMessage>) - Method in class springfox.documentation.spring.web.plugins.Docket
-
Deprecated.
- globalResponses(HttpMethod, List<Response>) - Method in class springfox.documentation.spring.web.plugins.Docket
-
Overrides the default http response messages at the http request method level.
- globalResponsesFor(HttpMethod) - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
- globalResponsesFor(HttpMethod) - Method in class springfox.documentation.spi.service.contexts.OperationContext
- GrantType - Class in springfox.documentation.service
- GrantType - Class in springfox.documentation.swagger1.dto
- GrantType() - Constructor for class springfox.documentation.swagger1.dto.GrantType
- GrantType(String) - Constructor for class springfox.documentation.service.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() - Method in interface springfox.documentation.RequestHandler
- groupName() - Method in class springfox.documentation.spring.web.plugins.CombinedRequestHandler
- 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
- groupName(String) - Method in class springfox.documentation.builders.ApiDescriptionBuilder
-
Updates the group name the api operation belongs to
- groupName(String) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
- groupName(String) - Method in class springfox.documentation.spring.web.plugins.Docket
-
If more than one instance of Docket exists, each one must have a unique groupName as supplied by this method.
H
- HAL_MEDIA_TYPE - Static variable in class springfox.documentation.oas.web.SpecGeneration
- HandlerMethodResolver - Class in springfox.documentation.spring.web.readers.operation
- HandlerMethodResolver(TypeResolver) - Constructor for class springfox.documentation.spring.web.readers.operation.HandlerMethodResolver
- hashCode() - Method in class springfox.documentation.common.Compatibility
- hashCode() - Method in class springfox.documentation.common.Either
- hashCode() - Method in class springfox.documentation.common.ExternalDocumentation
- hashCode() - Method in class springfox.documentation.common.Version
- hashCode() - Method in class springfox.documentation.oas.mappers.MapSchema
- hashCode() - Method in class springfox.documentation.RequestHandlerKey
- hashCode() - Method in class springfox.documentation.schema.CollectionElementFacet
- hashCode() - Method in class springfox.documentation.schema.CollectionSpecification
- hashCode() - Method in class springfox.documentation.schema.CompoundModelSpecification
- hashCode() - Method in class springfox.documentation.schema.EnumerationFacet
- hashCode() - Method in class springfox.documentation.schema.Example
- hashCode() - Method in class springfox.documentation.schema.MapSpecification
- hashCode() - Method in class springfox.documentation.schema.ModelFacets
- hashCode() - Method in class springfox.documentation.schema.ModelKey
- hashCode() - Method in class springfox.documentation.schema.ModelProperty
-
Deprecated.
- hashCode() - Method in class springfox.documentation.schema.ModelRef
-
Deprecated.
- hashCode() - Method in class springfox.documentation.schema.ModelSpecification
- hashCode() - Method in class springfox.documentation.schema.NumericElementFacet
- hashCode() - Method in class springfox.documentation.schema.PropertySpecification
- hashCode() - Method in class springfox.documentation.schema.QualifiedModelName
- hashCode() - Method in class springfox.documentation.schema.ReferenceModelSpecification
- hashCode() - Method in class springfox.documentation.schema.ScalarModelSpecification
- hashCode() - Method in class springfox.documentation.schema.ScalarType
- hashCode() - Method in class springfox.documentation.schema.StringElementFacet
- hashCode() - Method in class springfox.documentation.schema.Xml
- hashCode() - Method in class springfox.documentation.service.AllowableListValues
- hashCode() - Method in class springfox.documentation.service.AllowableRangeValues
- hashCode() - Method in class springfox.documentation.service.ApiDescription
- hashCode() - Method in class springfox.documentation.service.CollectionFormat
- hashCode() - Method in class springfox.documentation.service.ContentSpecification
- hashCode() - Method in class springfox.documentation.service.DocumentationReference
- hashCode() - Method in class springfox.documentation.service.Encoding
- hashCode() - Method in class springfox.documentation.service.Header
- hashCode() - Method in class springfox.documentation.service.ListVendorExtension
- hashCode() - Method in class springfox.documentation.service.ObjectVendorExtension
- hashCode() - Method in class springfox.documentation.service.ParameterSpecification
- hashCode() - Method in class springfox.documentation.service.Representation
- hashCode() - Method in class springfox.documentation.service.RequestParameter
- hashCode() - Method in class springfox.documentation.service.ResourceGroup
- hashCode() - Method in class springfox.documentation.service.Response
- hashCode() - Method in class springfox.documentation.service.ResponseMessage
-
Deprecated.
- hashCode() - Method in class springfox.documentation.service.Server
- hashCode() - Method in class springfox.documentation.service.ServerVariable
- hashCode() - Method in class springfox.documentation.service.SimpleParameterSpecification
- 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.scanners.ComparisonCondition
- 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
- hasRequestResponsePairs(ModelKey) - Method in interface springfox.documentation.spi.service.contexts.ModelSpecificationRegistry
- hasSeenBefore(ResolvedType) - Method in class springfox.documentation.spi.schema.contexts.ModelContext
-
Answers the question, has the given type been processed?
- hasSeenBefore(String) - Method in class springfox.documentation.spring.web.scanners.MergingContext
- 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, ModelSpecification) - Constructor for class springfox.documentation.service.Header
- Header(String, String, ModelReference, ModelSpecification, Boolean) - Constructor for class springfox.documentation.service.Header
- HEADER - springfox.documentation.service.ParameterType
- HEADER - springfox.documentation.swagger.web.ApiKeyVehicle
- HeaderParameterSpecificationProvider - Class in springfox.documentation.builders
- HeaderParameterSpecificationProvider() - Constructor for class springfox.documentation.builders.HeaderParameterSpecificationProvider
- 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
- headers(Header[]) - Static method in class springfox.documentation.swagger.readers.operation.ResponseHeaders
- headers(Collection<ResponseHeader>) - Static method in class springfox.documentation.swagger.readers.operation.ResponseHeaders
- headers(Collection<Header>) - Method in class springfox.documentation.builders.EncodingBuilder
- headers(Collection<Header>) - Method in class springfox.documentation.builders.ResponseBuilder
- headerStyle(ParameterStyle) - Method in class springfox.documentation.oas.mappers.StyleEnumMapper
- headersWithDescription(Map<String, Header>) - Method in class springfox.documentation.builders.ResponseMessageBuilder
-
Deprecated.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
-
Deprecated.Updates if the parameter is hidden
- hidden(Boolean) - Method in class springfox.documentation.builders.RequestParameterBuilder
- 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
- HttpAuthenticationBuilder - Class in springfox.documentation.builders
- HttpAuthenticationBuilder() - Constructor for class springfox.documentation.builders.HttpAuthenticationBuilder
- HttpAuthenticationScheme - Class in springfox.documentation.service
- HttpAuthenticationScheme(String, String, String, String, String, List<VendorExtension>) - Constructor for class springfox.documentation.service.HttpAuthenticationScheme
- HttpAuthenticationSchemeFactory - Class in springfox.documentation.swagger2.mappers
- HttpAuthenticationSchemeFactory() - Constructor for class springfox.documentation.swagger2.mappers.HttpAuthenticationSchemeFactory
- 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.ExampleBuilder
- ignorableTypes() - Method in class springfox.documentation.spring.web.readers.parameter.ExpansionContext
- ignoredParameterTypes(Class...) - Method in class springfox.documentation.spring.web.plugins.Docket
-
Adds ignored controller method parameter types so that the framework does not generate swagger model or parameter information for these specific types.
- ImplicitGrant - Class in springfox.documentation.service
- ImplicitGrant - Class in springfox.documentation.swagger1.dto
- ImplicitGrant() - Constructor for class springfox.documentation.swagger1.dto.ImplicitGrant
- ImplicitGrant(LoginEndpoint, String) - Constructor for class springfox.documentation.service.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) - Method in class springfox.documentation.schema.property.field.FieldProvider
- in(ResolvedType, Predicate<ResolvedParameterizedMember<?>>) - Method in class springfox.documentation.schema.property.FactoryMethodProvider
- in(String) - Method in class springfox.documentation.builders.RequestParameterBuilder
- in(ParameterType) - Method in class springfox.documentation.builders.RequestParameterBuilder
- Incubating - Annotation Type in springfox.documentation.annotations
- inferredServer(String, String) - Static method in class springfox.documentation.oas.web.SpecGeneration
- info(ApiInfo) - Method in class springfox.documentation.builders.ResourceListingBuilder
-
Updates the api information
- InMemorySwaggerResourcesProvider - Class in springfox.documentation.swagger.web
- InMemorySwaggerResourcesProvider(Environment, DocumentationCache, DocumentationPluginsManager) - Constructor for class springfox.documentation.swagger.web.InMemorySwaggerResourcesProvider
- inputParam(String, String, ResolvedType, Optional<ResolvedType>, Set<ResolvedType>, 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
- INTEGER - Static variable in class springfox.documentation.schema.ScalarType
- 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
-
Deprecated.Support for isAllowEmpty value
- isAllowEmptyValue() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- isAllowMultiple() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- 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.boot.starter.autoconfigure.SpringfoxConfigurationProperties
- isAutoStartup() - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper
- isBaseType(ResolvedType) - Static method in class springfox.documentation.schema.Types
-
Deprecated.
- isBaseType(String) - Static method in class springfox.documentation.schema.Types
-
Deprecated.
- isCollection() - Method in class springfox.documentation.schema.ModelRef
-
Deprecated.
- isCollection() - Method in interface springfox.documentation.schema.ModelReference
-
Deprecated.
- isContainerType(ResolvedType) - Static method in class springfox.documentation.schema.Collections
- isDefault() - Method in class springfox.documentation.service.Response
- isDefault(boolean) - Method in class springfox.documentation.builders.ResponseBuilder
- isEnabled() - Method in class springfox.boot.starter.autoconfigure.SpringfoxConfigurationProperties
- isEnabled() - Method in class springfox.boot.starter.autoconfigure.SpringfoxConfigurationProperties.OpenApiConfigurationProperties
- isEnabled() - Method in class springfox.boot.starter.autoconfigure.SpringfoxConfigurationProperties.Swagger2Configuration
- isEnabled() - Method in class springfox.boot.starter.autoconfigure.SpringfoxConfigurationProperties.SwaggerUiConfigurationProperties
- 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. - isHidden() - Method in class springfox.documentation.schema.ModelProperty
-
Deprecated.
- isHidden() - Method in class springfox.documentation.service.ApiDescription
- isHidden() - Method in class springfox.documentation.service.Operation
- isHidden() - Method in class springfox.documentation.service.Parameter
-
Deprecated.
- isHidden() - Method in class springfox.documentation.swagger1.dto.ApiDescription
- isHidden(Boolean) - Method in class springfox.documentation.builders.ModelPropertyBuilder
- isHidden(Boolean) - Method in class springfox.documentation.builders.PropertySpecificationBuilder
- 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
-
Deprecated.
- isMap() - Method in interface springfox.documentation.schema.ModelReference
-
Deprecated.
- 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
- IsNullAnnotationPlugin - Class in springfox.bean.validators.plugins.schema
- IsNullAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.schema.IsNullAnnotationPlugin
- isNullPlugin() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
- isReadOnly() - Method in class springfox.documentation.schema.ModelProperty
-
Deprecated.
- isReadOnly() - Method in class springfox.documentation.schema.property.BaseModelProperty
- isReadOnly() - Method in interface springfox.documentation.schema.property.ModelProperty
- isRequestBody() - Method in class springfox.documentation.service.ContentSpecification
- isRequestBody() - Method in class springfox.documentation.service.RequestParameter
- isRequired() - Method in class springfox.documentation.schema.ModelProperty
-
Deprecated.
- 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
-
Deprecated.
- isRequired() - Method in class springfox.documentation.swagger1.dto.ModelPropertyDto
- isRequired() - Method in class springfox.documentation.swagger1.dto.Parameter
- isResponse() - Method in class springfox.documentation.schema.ModelKey
- isResponse(boolean) - Method in class springfox.documentation.schema.ModelKeyBuilder
- 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
- isUniqueItems() - Method in class springfox.documentation.swagger1.dto.ContainerDataType
- isUriTemplatesEnabled() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext
- isUseModelV3() - Method in class springfox.boot.starter.autoconfigure.SpringfoxConfigurationProperties.Swagger2Configuration
- isVoid(ResolvedType) - Static method in class springfox.documentation.schema.ResolvedTypes
- itemModel() - Method in class springfox.documentation.schema.ModelRef
-
Deprecated.
- itemModel() - Method in interface springfox.documentation.schema.ModelReference
-
Deprecated.
J
- JacksonEnumTypeDeterminer - Class in springfox.documentation.schema
- JacksonEnumTypeDeterminer() - Constructor for class springfox.documentation.schema.JacksonEnumTypeDeterminer
- JacksonJsonViewProvider - Class in springfox.documentation.schema
- JacksonJsonViewProvider(TypeResolver) - Constructor for class springfox.documentation.schema.JacksonJsonViewProvider
- 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
- JacksonXmlModelPlugin - Class in springfox.documentation.schema.plugins
- JacksonXmlModelPlugin(TypeResolver) - Constructor for class springfox.documentation.schema.plugins.JacksonXmlModelPlugin
- JacksonXmlPresentInClassPathCondition - Class in springfox.documentation.schema
- JacksonXmlPresentInClassPathCondition() - Constructor for class springfox.documentation.schema.JacksonXmlPresentInClassPathCondition
- JacksonXmlPropertyPlugin - Class in springfox.documentation.schema.property
- JacksonXmlPropertyPlugin() - Constructor for class springfox.documentation.schema.property.JacksonXmlPropertyPlugin
- 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
- JsonIgnorePropertiesModelPlugin - Class in springfox.documentation.schema.plugins
- JsonIgnorePropertiesModelPlugin(TypeResolver) - Constructor for class springfox.documentation.schema.plugins.JsonIgnorePropertiesModelPlugin
- jsonSerializer(List<JacksonModuleRegistrar>) - Method in class springfox.documentation.spring.web.SpringfoxWebConfiguration
- JsonSerializer - Class in springfox.documentation.spring.web.json
- JsonSerializer(List<JacksonModuleRegistrar>) - Constructor for class springfox.documentation.spring.web.json.JsonSerializer
- JWT_BEARER_BUILDER - Static variable in class springfox.documentation.service.HttpAuthenticationScheme
K
- key() - Method in interface springfox.documentation.RequestHandler
- key() - Method in class springfox.documentation.schema.ModelSpecification
- 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
- key(Consumer<ModelSpecificationBuilder>) - Method in class springfox.documentation.builders.MapSpecificationBuilder
- key(Consumer<ModelKeyBuilder>) - Method in class springfox.documentation.builders.ReferenceModelSpecificationBuilder
L
- LABEL - springfox.documentation.service.ParameterStyle
- license(String) - Method in class springfox.documentation.builders.ApiInfoBuilder
-
Updates license information for this API
- LicenseMapper - Class in springfox.documentation.oas.mappers
- LicenseMapper - Class in springfox.documentation.swagger2.mappers
- LicenseMapper() - Constructor for class springfox.documentation.oas.mappers.LicenseMapper
- LicenseMapper() - Constructor for class springfox.documentation.swagger2.mappers.LicenseMapper
- LicenseMapper.License - Annotation Type in springfox.documentation.oas.mappers
- 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
- LIST - springfox.documentation.schema.CollectionType
- LIST - springfox.documentation.swagger.web.DocExpansion
- 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 - Class in springfox.documentation.swagger1.dto
- LoginEndpoint() - Constructor for class springfox.documentation.swagger1.dto.LoginEndpoint
- LoginEndpoint(String) - Constructor for class springfox.documentation.service.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
- LONG - Static variable in class springfox.documentation.schema.ScalarType
M
- map(Set<Response>, ModelNamesRegistry) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- map(Contact) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- map(Contact) - Method in interface springfox.documentation.swagger1.mappers.ServiceModelToSwaggerMapper
- map(Contact) - Method in class springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper
- map(RequestBody, ModelNamesRegistry) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- mapApiInfo(ApiInfo) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- 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
- mapDocumentation(Documentation) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- mapDocumentation(Documentation) - Method in class springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper
- mapEncoding(Encoding, ModelNamesRegistry) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- mapExamples(Collection<Example>) - Method in interface springfox.documentation.oas.mappers.ExamplesMapper
- mapExamples(List<Example>) - Method in class springfox.documentation.swagger2.mappers.ExamplesMapper
- mapExtensions(Collection<VendorExtension>) - Method in class springfox.documentation.oas.mappers.VendorExtensionsMapper
- mapExtensions(List<VendorExtension>) - Method in class springfox.documentation.swagger2.mappers.VendorExtensionsMapper
- mapExternalDocs(ExternalDocumentation) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- mapFrom(Map<String, List<AuthorizationScope>>) - Method in class springfox.documentation.oas.mappers.SecurityMapper
- mapFrom(ModelSpecification, ModelNamesRegistry) - Method in class springfox.documentation.oas.mappers.SchemaMapper
- mapHeader(Header, ModelNamesRegistry) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- mapKeyType(ResolvedType) - Static method in class springfox.documentation.schema.Maps
- mapModel(Consumer<MapSpecificationBuilder>) - Method in class springfox.documentation.builders.ModelSpecificationBuilder
-
Provides a consumer to build the map model.
- mapModel(ModelSpecification, ModelNamesRegistry) - Method in class springfox.documentation.oas.mappers.SchemaMapper
- mapModelIfExists(Consumer<MapSpecificationBuilder>) - Method in class springfox.documentation.builders.ModelSpecificationBuilder
-
Conditionally provides a consumer to build the map model.
- mapModels(Map<String, Model>) - Method in class springfox.documentation.swagger2.mappers.ModelMapper
-
Deprecated.
- mapModels(Map<String, ModelSpecification>, ModelNamesRegistry) - Method in class springfox.documentation.oas.mappers.SchemaMapper
- mapModels(Map<String, ModelSpecification>, ModelNamesRegistry) - Method in class springfox.documentation.swagger2.mappers.ModelSpecificationMapper
- mapModels(ModelSpecification, ModelNamesRegistry) - Method in class springfox.documentation.swagger2.mappers.ModelSpecificationMapper
- mapOperation(Operation, ModelNamesRegistry) - Method in class springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper
- mapParameter(Parameter) - Method in class springfox.documentation.swagger2.mappers.ParameterMapper
-
Deprecated.
- Mappers - Class in springfox.documentation.swagger1.mappers
- mapProperties(Map<String, PropertySpecification>, ModelNamesRegistry) - Method in class springfox.documentation.oas.mappers.SchemaMapper
- mapProperties(Map<String, PropertySpecification>, ModelNamesRegistry) - Method in class springfox.documentation.swagger2.mappers.ModelSpecificationMapper
- mapResponseMessages(Set<ResponseMessage>) - Method in class springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper
-
Deprecated.
- mapResponses(Set<Response>, ModelNamesRegistry) - Method in class springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper
- Maps - Class in springfox.documentation.schema
- MapSchema - Class in springfox.documentation.oas.mappers
-
MapSchema
- MapSchema() - Constructor for class springfox.documentation.oas.mappers.MapSchema
- mapSchemes(List<String>) - Method in class springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper
- mapServer(Server) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- mapServerVariable(ServerVariable) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- MapSpecification - Class in springfox.documentation.schema
- MapSpecification(ModelSpecification, ModelSpecification) - Constructor for class springfox.documentation.schema.MapSpecification
- MapSpecificationBuilder - Class in springfox.documentation.builders
- MapSpecificationBuilder() - Constructor for class springfox.documentation.builders.MapSpecificationBuilder
- MapSpecificationToPropertyConverter - Class in springfox.documentation.swagger2.mappers
- MapSpecificationToPropertyConverter(ModelNamesRegistry) - Constructor for class springfox.documentation.swagger2.mappers.MapSpecificationToPropertyConverter
- MapSpecificationToSchemaConverter - Class in springfox.documentation.oas.mappers
- MapSpecificationToSchemaConverter(ModelNamesRegistry) - Constructor for class springfox.documentation.oas.mappers.MapSpecificationToSchemaConverter
- mapTag(Tag) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- 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.common.ClassNotPresentInClassPathCondition
- matches(ConditionContext, AnnotatedTypeMetadata) - Method in class springfox.documentation.common.ClassPresentInClassPathCondition
- matches(ConditionContext, AnnotatedTypeMetadata) - Method in class springfox.documentation.spring.web.plugins.SpringIntegrationPluginNotPresentInClassPathCondition
- MATRIX - springfox.documentation.service.ParameterStyle
- maxDisplayedTags(Integer) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
- maximum(BigDecimal) - Method in class springfox.documentation.schema.NumericElementFacetBuilder
- maxItems(Integer) - Method in class springfox.documentation.builders.CollectionElementFacetBuilder
- maxLength(Integer) - Method in class springfox.documentation.builders.StringElementFacetBuilder
- maxProperties(Integer) - Method in class springfox.documentation.builders.CompoundModelSpecificationBuilder
-
Provides override for the max properties.
- 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
- maybeConvertToScalar(ScalarType) - Method in class springfox.documentation.builders.ModelSpecificationBuilder
-
This is an experimental API.
- maybeRegisterModule(ObjectMapper) - Method in class springfox.documentation.oas.configuration.OpenApiJacksonModule
- 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
- mediaType(String) - Method in class springfox.documentation.builders.ExampleBuilder
- mediaType(String) - Method in class springfox.documentation.builders.RepresentationBuilder
- mediaType(MediaType) - Method in class springfox.documentation.builders.RepresentationBuilder
- 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
- MergingContext - Class in springfox.documentation.spring.web.scanners
- MergingContext(String, Map<String, Set<Model>>, Map<String, String>, Map<String, Model>, Map<String, ModelContext>) - Constructor for class springfox.documentation.spring.web.scanners.MergingContext
- message(String) - Method in class springfox.documentation.builders.ResponseMessageBuilder
-
Deprecated.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
- METHOD - springfox.documentation.swagger.web.OperationsSorter
- methodComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings
- methodParameter() - Method in class springfox.documentation.spi.service.contexts.ParameterContext
-
Deprecated.Use
ParameterContext.resolvedMethodParameter()
instead - 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
- minimum(BigDecimal) - Method in class springfox.documentation.schema.NumericElementFacetBuilder
- minItems(Integer) - Method in class springfox.documentation.builders.CollectionElementFacetBuilder
- minLength(Integer) - Method in class springfox.documentation.builders.StringElementFacetBuilder
- MinMaxAnnotationPlugin - Class in springfox.bean.validators.plugins.parameter
- MinMaxAnnotationPlugin - Class in springfox.bean.validators.plugins.schema
- MinMaxAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.parameter.MinMaxAnnotationPlugin
- MinMaxAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.schema.MinMaxAnnotationPlugin
- minMaxPlugin() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
- minProperties(Integer) - Method in class springfox.documentation.builders.CompoundModelSpecificationBuilder
-
Provides override for the min properties.
- model(Consumer<ModelSpecificationBuilder>) - Method in class springfox.documentation.builders.CollectionSpecificationBuilder
- model(Consumer<ModelSpecificationBuilder>) - Method in class springfox.documentation.builders.RepresentationBuilder
- model(Consumer<ModelSpecificationBuilder>) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder
-
Provides consumer to help build models
- model(ModelContext) - Method in class springfox.documentation.schema.plugins.SchemaPluginsManager
-
Deprecated.
- Model - Class in springfox.documentation.schema
-
Deprecated.
- Model(String, String, ResolvedType, String, Map<String, ModelProperty>, String, String, String, List<ModelReference>, Object, Xml) - Constructor for class springfox.documentation.schema.Model
-
Deprecated.
- MODEL - springfox.documentation.swagger.web.ModelRendering
- 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
-
Deprecated.
- ModelBuilder(String) - Constructor for class springfox.documentation.builders.ModelBuilder
-
Deprecated.Constructor with the Id of the model
- ModelBuilder(Model) - Constructor for class springfox.documentation.builders.ModelBuilder
-
Deprecated.Constructor with the model
- 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
- modelDependenciesSpecifications(ModelContext) - Method in class springfox.documentation.schema.CachingModelProvider
- modelDependenciesSpecifications(ModelContext) - Method in class springfox.documentation.schema.DefaultModelSpecificationProvider
- modelDependenciesSpecifications(ModelContext) - Method in interface springfox.documentation.schema.ModelSpecificationProvider
- 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
- ModelFacets - Class in springfox.documentation.schema
- ModelFacets(String, String, Boolean, Boolean, Collection<ElementFacet>, Xml, ExternalDocumentation, List<Example>, List<VendorExtension>) - Constructor for class springfox.documentation.schema.ModelFacets
- ModelFacetsBuilder - Class in springfox.documentation.builders
- ModelFacetsBuilder() - Constructor for class springfox.documentation.builders.ModelFacetsBuilder
- modelFor(ModelContext) - Method in class springfox.documentation.schema.CachingModelProvider
- modelFor(ModelContext) - Method in class springfox.documentation.schema.DefaultModelProvider
-
Deprecated.
- modelFor(ModelContext) - Method in interface springfox.documentation.schema.ModelProvider
-
Deprecated.
- modelKey(Consumer<ModelKeyBuilder>) - Method in class springfox.documentation.builders.CompoundModelSpecificationBuilder
-
Provides a fluent builder consumer for building a model key
- ModelKey - Class in springfox.documentation.schema
- ModelKey(QualifiedModelName, ResolvedType, Collection<ResolvedType>, boolean) - Constructor for class springfox.documentation.schema.ModelKey
- ModelKeyBuilder - Class in springfox.documentation.schema
- ModelKeyBuilder() - Constructor for class springfox.documentation.schema.ModelKeyBuilder
- modelKeys() - Method in interface springfox.documentation.spi.service.contexts.ModelSpecificationRegistry
- ModelMapper - Class in springfox.documentation.swagger2.mappers
-
Deprecated.
- ModelMapper() - Constructor for class springfox.documentation.swagger2.mappers.ModelMapper
-
Deprecated.
- modelNamesGeneratorFactory(DocumentationType) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
- modelNamesRegistry(ModelNamesRegistry) - Method in class springfox.documentation.builders.ApiListingBuilder
- modelNamesRegistry(ModelSpecificationRegistry) - Method in interface springfox.documentation.spi.service.ModelNamesRegistryFactoryPlugin
- modelNamesRegistry(ModelSpecificationRegistry) - Method in class springfox.documentation.spring.web.scanners.DefaultModelNamesRegistryFactory
- ModelNamesRegistry - Interface in springfox.documentation.service
- ModelNamesRegistryFactoryPlugin - Interface in springfox.documentation.spi.service
- ModelPropertiesProvider - Interface in springfox.documentation.schema.property
- ModelProperty - Class in springfox.documentation.schema
-
Deprecated.
- ModelProperty - Interface in springfox.documentation.schema.property
- ModelProperty(String, ResolvedType, String, int, boolean, boolean, boolean, Boolean, String, AllowableValues, Object, String, String, Xml, List<VendorExtension>) - Constructor for class springfox.documentation.schema.ModelProperty
-
Deprecated.
- ModelPropertyBuilder - Class in springfox.documentation.builders
- ModelPropertyBuilder() - Constructor for class springfox.documentation.builders.ModelPropertyBuilder
- ModelPropertyBuilder(ModelProperty) - Constructor for class springfox.documentation.builders.ModelPropertyBuilder
- ModelPropertyBuilderPlugin - Interface in springfox.documentation.spi.schema
- ModelPropertyContext - Class in springfox.documentation.spi.schema.contexts
- ModelPropertyContext(ModelPropertyBuilder, BeanPropertyDefinition, TypeResolver, ModelContext, PropertySpecificationBuilder) - Constructor for class springfox.documentation.spi.schema.contexts.ModelPropertyContext
- ModelPropertyContext(ModelPropertyBuilder, PropertySpecificationBuilder, AnnotatedElement, TypeResolver, ModelContext) - 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
-
Deprecated.
- modelRef(ModelReference) - Method in class springfox.documentation.builders.ParameterBuilder
-
Deprecated.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
-
Deprecated.
- ModelRef(String) - Constructor for class springfox.documentation.schema.ModelRef
-
Deprecated.
- ModelRef(String, String, ModelReference, AllowableValues, boolean, String) - Constructor for class springfox.documentation.schema.ModelRef
-
Deprecated.
- ModelRef(String, String, ModelReference, AllowableValues, String) - Constructor for class springfox.documentation.schema.ModelRef
-
Deprecated.
- ModelRef(String, ModelReference) - Constructor for class springfox.documentation.schema.ModelRef
-
Deprecated.
- ModelRef(String, ModelReference, boolean) - Constructor for class springfox.documentation.schema.ModelRef
-
Deprecated.
- ModelRef(String, AllowableValues) - Constructor for class springfox.documentation.schema.ModelRef
-
Deprecated.
- ModelReference - Interface in springfox.documentation.schema
-
Deprecated.
- modelRefFactory(ModelContext, EnumTypeDeterminer, TypeNameExtractor) - Static method in class springfox.documentation.schema.ResolvedTypes
- modelRefFactory(ModelContext, EnumTypeDeterminer, TypeNameExtractor, Map<String, String>) - 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
- modelsByName() - Method in interface springfox.documentation.service.ModelNamesRegistry
- ModelsConfiguration - Class in springfox.documentation.schema.configuration
- ModelsConfiguration() - Constructor for class springfox.documentation.schema.configuration.ModelsConfiguration
- modelsDifferingOnlyInValidationGroups(ModelKey) - Method in interface springfox.documentation.spi.service.contexts.ModelSpecificationRegistry
- modelsFromApiListings(Map<String, List<ApiListing>>) - Method in class springfox.documentation.oas.mappers.SchemaMapper
- modelsFromApiListings(Map<String, List<ApiListing>>) - Method in class springfox.documentation.swagger2.mappers.ModelSpecificationMapper
- modelSpecification(ModelContext) - Method in class springfox.documentation.schema.plugins.SchemaPluginsManager
- ModelSpecification - Class in springfox.documentation.schema
- ModelSpecification(String, ModelFacets, ScalarModelSpecification, CompoundModelSpecification, CollectionSpecification, MapSpecification, ReferenceModelSpecification) - Constructor for class springfox.documentation.schema.ModelSpecification
- ModelSpecificationBuilder - Class in springfox.documentation.builders
- ModelSpecificationBuilder() - Constructor for class springfox.documentation.builders.ModelSpecificationBuilder
- ModelSpecificationFactory - Class in springfox.documentation.schema.property
- ModelSpecificationFactory(TypeNameExtractor, EnumTypeDeterminer) - Constructor for class springfox.documentation.schema.property.ModelSpecificationFactory
- modelSpecificationFor(ModelKey) - Method in interface springfox.documentation.spi.service.contexts.ModelSpecificationRegistry
- ModelSpecificationInheritanceDeterminer - Class in springfox.documentation.oas.mappers
- ModelSpecificationInheritanceDeterminer - Class in springfox.documentation.swagger2.mappers
- ModelSpecificationInheritanceDeterminer(ModelNamesRegistry) - Constructor for class springfox.documentation.oas.mappers.ModelSpecificationInheritanceDeterminer
- ModelSpecificationInheritanceDeterminer(ModelNamesRegistry) - Constructor for class springfox.documentation.swagger2.mappers.ModelSpecificationInheritanceDeterminer
- ModelSpecificationMapper - Class in springfox.documentation.swagger2.mappers
- ModelSpecificationMapper() - Constructor for class springfox.documentation.swagger2.mappers.ModelSpecificationMapper
- ModelSpecificationProvider - Interface in springfox.documentation.schema
- ModelSpecificationRegistry - Interface in springfox.documentation.spi.service.contexts
- ModelSpecificationRegistryBuilder - Class in springfox.documentation.spring.web.scanners
- ModelSpecificationRegistryBuilder() - Constructor for class springfox.documentation.spring.web.scanners.ModelSpecificationRegistryBuilder
- modelSpecifications(Map<String, ModelSpecification>) - Method in class springfox.documentation.builders.ApiListingBuilder
-
Adds to the models collection
- modelSpecificationsFor(ModelContext) - Method in class springfox.documentation.schema.CachingModelProvider
- modelSpecificationsFor(ModelContext) - Method in class springfox.documentation.schema.DefaultModelSpecificationProvider
- modelSpecificationsFor(ModelContext) - Method in interface springfox.documentation.schema.ModelSpecificationProvider
- modelsWithSameNameAndDifferentNamespace(ModelKey) - Method in interface springfox.documentation.spi.service.contexts.ModelSpecificationRegistry
- MULTI - Static variable in class springfox.documentation.service.CollectionFormat
- MultipartFormDataParameterSpecificationProvider - Class in springfox.documentation.builders
- MultipartFormDataParameterSpecificationProvider() - Constructor for class springfox.documentation.builders.MultipartFormDataParameterSpecificationProvider
- multipleOf(BigDecimal) - Method in class springfox.documentation.schema.NumericElementFacetBuilder
N
- name(BeanPropertyDefinition, boolean, BeanPropertyNamingStrategy, String) - Static method in class springfox.documentation.schema.property.BeanPropertyDefinitions
- name(String) - Method in class springfox.documentation.builders.AlternateTypePropertyBuilder
- name(String) - Method in class springfox.documentation.builders.DocumentationBuilder
-
Name of the documentation group
- name(String) - Method in class springfox.documentation.builders.HttpAuthenticationBuilder
- name(String) - Method in class springfox.documentation.builders.ModelBuilder
-
Deprecated.Updates the Name of the model
- name(String) - Method in class springfox.documentation.builders.ModelPropertyBuilder
- name(String) - Method in class springfox.documentation.builders.ModelSpecificationBuilder
-
Updates the name of the model
- name(String) - Method in class springfox.documentation.builders.OAuth2SchemeBuilder
- 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.OpenIdConnectSchemeBuilder
- name(String) - Method in class springfox.documentation.builders.ParameterBuilder
-
Deprecated.Updates the parameter name
- name(String) - Method in class springfox.documentation.builders.QualifiedModelNameBuilder
- name(String) - Method in class springfox.documentation.builders.RequestParameterBuilder
- name(String) - Method in class springfox.documentation.builders.ServerBuilder
- name(String) - Method in class springfox.documentation.builders.ServerVariableBuilder
- name(String) - Method in class springfox.documentation.schema.Xml
- nameByKey(ModelKey) - Method in interface springfox.documentation.service.ModelNamesRegistry
- 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.builders.QualifiedModelNameBuilder
- 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 typeList<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.
- next(Swagger) - Method in class springfox.documentation.swagger2.web.SwaggerTransformationContext
- next(OpenAPI) - Method in class springfox.documentation.oas.web.OpenApiTransformationContext
- 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
- NONE - springfox.documentation.swagger.web.DocExpansion
- NONE - Static variable in class springfox.documentation.service.CollectionFormat
- NoopValidator<T> - Class in springfox.documentation.builders
- NoopValidator() - Constructor for class springfox.documentation.builders.NoopValidator
- NOT - springfox.documentation.service.Qualifier
- NotBlankAnnotationPlugin - Class in springfox.bean.validators.plugins.parameter
- NotBlankAnnotationPlugin - Class in springfox.bean.validators.plugins.schema
- NotBlankAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.parameter.NotBlankAnnotationPlugin
- NotBlankAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.schema.NotBlankAnnotationPlugin
- notBlankPlugin() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
- notes(String) - Method in class springfox.documentation.builders.OperationBuilder
-
Updates the operation notes
- NotNullAnnotationPlugin - Class in springfox.bean.validators.plugins.parameter
- NotNullAnnotationPlugin - Class in springfox.bean.validators.plugins.schema
- NotNullAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.parameter.NotNullAnnotationPlugin
- NotNullAnnotationPlugin() - Constructor for class springfox.bean.validators.plugins.schema.NotNullAnnotationPlugin
- notNullPlugin() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
- nullable(Boolean) - Method in class springfox.documentation.builders.ModelFacetsBuilder
- nullable(Boolean) - Method in class springfox.documentation.builders.PropertySpecificationBuilder
- nullSafeIsExplode() - Method in class springfox.documentation.service.SimpleParameterSpecification
- nullSafeIsRequired() - Method in class springfox.documentation.schema.PropertySpecification
- nullToEmpty(String) - Static method in class springfox.documentation.builders.BuilderDefaults
- nullToEmptyArray(T[]) - Static method in class springfox.documentation.builders.BuilderDefaults
-
Returns an empty list if the newValue is null
- 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
- NumericElementFacet - Class in springfox.documentation.schema
- NumericElementFacet(BigDecimal, BigDecimal, Boolean, BigDecimal, Boolean) - Constructor for class springfox.documentation.schema.NumericElementFacet
- NumericElementFacetBuilder - Class in springfox.documentation.schema
- NumericElementFacetBuilder() - Constructor for class springfox.documentation.schema.NumericElementFacetBuilder
- numericFacet(Consumer<NumericElementFacetBuilder>) - Method in class springfox.documentation.builders.ModelFacetsBuilder
- numericFacet(Consumer<NumericElementFacetBuilder>) - Method in class springfox.documentation.builders.PropertySpecificationBuilder
- numericFacet(Consumer<NumericElementFacetBuilder>) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder
-
Provides consumer to help build numeric element facet
O
- OAS_30 - Static variable in class springfox.documentation.spi.DocumentationType
- OAS_PLUGIN_ORDER - Static variable in class springfox.documentation.swagger.common.SwaggerPluginSupport
- OAuth - Class in springfox.documentation.service
- OAuth - Class in springfox.documentation.swagger1.dto
- OAuth() - Constructor for class springfox.documentation.swagger1.dto.OAuth
- OAuth(String, List<AuthorizationScope>, List<GrantType>) - Constructor for class springfox.documentation.service.OAuth
- OAuth(String, List<AuthorizationScope>, List<GrantType>, List<VendorExtension>) - Constructor for class springfox.documentation.service.OAuth
- OAuth(List<AuthorizationScope>, List<GrantType>) - Constructor for class springfox.documentation.swagger1.dto.OAuth
- OAUTH2_AUTHORIZATION_CODE_FLOW_BUILDER - Static variable in class springfox.documentation.service.OAuth2Scheme
- OAUTH2_CLIENT_CREDENTIALS_FLOW_BUILDER - Static variable in class springfox.documentation.service.OAuth2Scheme
- OAUTH2_IMPLICIT_FLOW_BUILDER - Static variable in class springfox.documentation.service.OAuth2Scheme
- OAUTH2_PASSWORD_FLOW_BUILDER - Static variable in class springfox.documentation.service.OAuth2Scheme
- OAuth2Scheme - Class in springfox.documentation.service
- OAuth2Scheme(String, String, String, String, String, String, List<AuthorizationScope>, List<VendorExtension>) - Constructor for class springfox.documentation.service.OAuth2Scheme
- OAuth2SchemeBuilder - Class in springfox.documentation.builders
- OAuth2SchemeBuilder(String) - Constructor for class springfox.documentation.builders.OAuth2SchemeBuilder
- OAuth2SchemeValidator<T> - Class in springfox.documentation.builders
- OAuth2SchemeValidator() - Constructor for class springfox.documentation.builders.OAuth2SchemeValidator
- OAuthBuilder - Class in springfox.documentation.builders
- OAuthBuilder() - Constructor for class springfox.documentation.builders.OAuthBuilder
- OBJECT - Static variable in class springfox.documentation.schema.ScalarType
- 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.
- 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
- 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
- ONE_OF - springfox.documentation.service.Qualifier
- OnNotServletBasedWebApplication - Class in springfox.documentation.spring.web
- OnNotServletBasedWebApplication() - Constructor for class springfox.documentation.spring.web.OnNotServletBasedWebApplication
- OnReactiveWebApplication - Class in springfox.documentation.spring.web
- OnReactiveWebApplication() - Constructor for class springfox.documentation.spring.web.OnReactiveWebApplication
- OnServletBasedWebApplication - Class in springfox.documentation.spring.web
- OnServletBasedWebApplication() - Constructor for class springfox.documentation.spring.web.OnServletBasedWebApplication
- OPEN_API_SPECIFICATION_PATH - Static variable in class springfox.documentation.oas.web.SpecGeneration
- OpenApiAutoConfiguration - Class in springfox.boot.starter.autoconfigure
- OpenApiAutoConfiguration() - Constructor for class springfox.boot.starter.autoconfigure.OpenApiAutoConfiguration
- OpenApiConfigurationProperties() - Constructor for class springfox.boot.starter.autoconfigure.SpringfoxConfigurationProperties.OpenApiConfigurationProperties
- OpenApiControllerWebFlux - Class in springfox.documentation.oas.web
- OpenApiControllerWebFlux(DocumentationCache, ServiceModelToOpenApiMapper, JsonSerializer, PluginRegistry<WebFluxOpenApiTransformationFilter, DocumentationType>) - Constructor for class springfox.documentation.oas.web.OpenApiControllerWebFlux
- OpenApiControllerWebMvc - Class in springfox.documentation.oas.web
- OpenApiControllerWebMvc(DocumentationCache, ServiceModelToOpenApiMapper, JsonSerializer, PluginRegistry<WebMvcOpenApiTransformationFilter, DocumentationType>) - Constructor for class springfox.documentation.oas.web.OpenApiControllerWebMvc
- OpenApiDocumentationConfiguration - Class in springfox.documentation.oas.configuration
- OpenApiDocumentationConfiguration() - Constructor for class springfox.documentation.oas.configuration.OpenApiDocumentationConfiguration
- OpenApiJacksonModule - Class in springfox.documentation.oas.configuration
- OpenApiJacksonModule() - Constructor for class springfox.documentation.oas.configuration.OpenApiJacksonModule
- OpenApiMappingConfiguration - Class in springfox.documentation.oas.configuration
- OpenApiMappingConfiguration() - Constructor for class springfox.documentation.oas.configuration.OpenApiMappingConfiguration
- openApiModule() - Method in class springfox.documentation.oas.configuration.OpenApiMappingConfiguration
- OpenApiOperationAuthReader - Class in springfox.documentation.swagger.readers.operation
- OpenApiOperationAuthReader() - Constructor for class springfox.documentation.swagger.readers.operation.OpenApiOperationAuthReader
- OpenApiOperationTagsReader - Class in springfox.documentation.swagger.readers.operation
- OpenApiOperationTagsReader() - Constructor for class springfox.documentation.swagger.readers.operation.OpenApiOperationTagsReader
- OpenApiParameterBuilder - Class in springfox.documentation.swagger.readers.parameter
- OpenApiParameterBuilder(DescriptionResolver) - Constructor for class springfox.documentation.swagger.readers.parameter.OpenApiParameterBuilder
- OpenApiResponseReader - Class in springfox.documentation.swagger.readers.operation
- OpenApiResponseReader(TypeResolver, ModelSpecificationFactory, DocumentationPluginsManager) - Constructor for class springfox.documentation.swagger.readers.operation.OpenApiResponseReader
- OpenApiSchemaPropertyBuilder - Class in springfox.documentation.swagger.schema
- OpenApiSchemaPropertyBuilder(DescriptionResolver, ModelSpecificationFactory) - Constructor for class springfox.documentation.swagger.schema.OpenApiSchemaPropertyBuilder
- OpenApiTransformationContext<T> - Class in springfox.documentation.oas.web
- OpenApiTransformationFilter<T> - Interface in springfox.documentation.oas.web
- OpenApiWebFluxConfiguration - Class in springfox.documentation.oas.configuration
- OpenApiWebFluxConfiguration() - Constructor for class springfox.documentation.oas.configuration.OpenApiWebFluxConfiguration
- OpenApiWebMvcConfiguration - Class in springfox.documentation.oas.configuration
- OpenApiWebMvcConfiguration() - Constructor for class springfox.documentation.oas.configuration.OpenApiWebMvcConfiguration
- OpenIdConnectScheme - Class in springfox.documentation.service
- OpenIdConnectScheme(String, String, List<VendorExtension>, String) - Constructor for class springfox.documentation.service.OpenIdConnectScheme
- OpenIdConnectSchemeBuilder - Class in springfox.documentation.builders
- OpenIdConnectSchemeBuilder() - Constructor for class springfox.documentation.builders.OpenIdConnectSchemeBuilder
- OpenIdConnectSchemeFactory - Class in springfox.documentation.swagger2.mappers
- OpenIdConnectSchemeFactory() - Constructor for class springfox.documentation.swagger2.mappers.OpenIdConnectSchemeFactory
- openIdConnectUrl(String) - Method in class springfox.documentation.builders.OpenIdConnectSchemeBuilder
- operation(OperationContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
- Operation - Class in springfox.documentation.service
- 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
- Operation(HttpMethod, String, String, ExternalDocumentation, ModelReference, String, int, Set<String>, Set<String>, Set<String>, Set<String>, List<SecurityReference>, List<Parameter>, Set<ResponseMessage>, String, boolean, Collection<VendorExtension>, Set<RequestParameter>, RequestBody, Set<Response>) - Constructor for class springfox.documentation.service.Operation
- OperationAuthReader - Class in springfox.documentation.swagger.readers.operation
- OperationAuthReader() - Constructor for class springfox.documentation.swagger.readers.operation.OperationAuthReader
- operationBuilder() - Method in class springfox.documentation.spi.service.contexts.OperationContext
- OperationBuilder - Class in springfox.documentation.builders
- OperationBuilder(OperationNameGenerator) - Constructor for class springfox.documentation.builders.OperationBuilder
- 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, String, AlternateTypeProvider, GenericTypeNamingStrategy, Set<Class>) - Constructor for class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder
- operationModelsBuilder() - Method in class springfox.documentation.spi.service.contexts.OperationContext
- operationModelsBuilder() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
- OperationModelsProvider - Class in springfox.documentation.spring.web.readers.operation
- OperationModelsProvider(SchemaPluginsManager) - 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() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext
- operationOrdering(Comparator<Operation>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder
- operationOrdering(Comparator<Operation>) - Method in class springfox.documentation.spring.web.plugins.Docket
-
Provide an ordering schema for operations
- OperationParameterHeadersConditionReader - Class in springfox.documentation.spring.web.readers.operation
- OperationParameterHeadersConditionReader(TypeResolver) - Constructor for class springfox.documentation.spring.web.readers.operation.OperationParameterHeadersConditionReader
- OperationParameterReader - Class in springfox.documentation.spring.web.readers.operation
- OperationParameterReader(ModelAttributeParameterExpander, EnumTypeDeterminer, ParameterAggregator) - Constructor for class springfox.documentation.spring.web.readers.operation.OperationParameterReader
- OperationParameterRequestConditionReader - Class in springfox.documentation.spring.web.readers.operation
- OperationParameterRequestConditionReader(TypeResolver) - Constructor for class springfox.documentation.spring.web.readers.operation.OperationParameterRequestConditionReader
- 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(SchemaPluginsManager, EnumTypeDeterminer, 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
- operationSelector(Predicate<OperationContext>) - Method in class springfox.documentation.spi.service.contexts.SecurityContextBuilder
- operationsSorter(OperationsSorter) - Method in class springfox.documentation.swagger.web.UiConfigurationBuilder
- OperationsSorter - Enum in springfox.documentation.swagger.web
- 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() - Constructor for class springfox.documentation.spring.web.readers.operation.OperationTagsReader
- operationTypeFromModelRef(ModelReference) - Method in class springfox.documentation.swagger1.mappers.DataTypeMapper
-
Deprecated.
- OptimizedModelPropertiesProvider - Class in springfox.documentation.schema.property
- OptimizedModelPropertiesProvider(AccessorsProvider, FieldProvider, FactoryMethodProvider, TypeResolver, BeanPropertyNamingStrategy, SchemaPluginsManager, EnumTypeDeterminer, TypeNameExtractor, ModelSpecificationFactory) - 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
-
Deprecated.Updates default order of precedence of parameters
- Orderings - Class in springfox.documentation.spi.service.contexts
- overTheWireName(BeanPropertyDefinition, MapperConfig<?>) - Static method in class springfox.documentation.schema.property.BeanPropertyDefinitions
P
- PackageNames - Class in springfox.documentation.schema.property
- pageableConvention(TypeResolver, RepositoryRestConfiguration) - Method in class springfox.documentation.spring.data.rest.configuration.SpringDataRestConfiguration
- parameter(ParameterContext) - Method in class springfox.documentation.spring.web.plugins.DocumentationPluginsManager
- Parameter - Class in springfox.documentation.service
-
Deprecated.
- Parameter - Class in springfox.documentation.swagger1.dto
- Parameter() - Constructor for class springfox.documentation.swagger1.dto.Parameter
- Parameter(String, String, String, boolean, boolean, Boolean, ModelReference, ResolvedType, AllowableValues, ParameterType, String, boolean, String, String, int, Object, Map<String, List<Example>>, List<VendorExtension>, ParameterStyle, Boolean, Boolean) - Constructor for class springfox.documentation.service.Parameter
-
Deprecated.
- 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
-
Deprecated.Updates the parameter access
- ParameterAggregator - Interface in springfox.documentation.spring.web.readers.operation
- ParameterAnnotationReader - Class in springfox.documentation.swagger.readers.parameter
- parameterBuilder() - Method in class springfox.documentation.spi.service.contexts.ParameterContext
-
Deprecated.
- ParameterBuilder - Class in springfox.documentation.builders
-
Deprecated.
- ParameterBuilder() - Constructor for class springfox.documentation.builders.ParameterBuilder
-
Deprecated.
- ParameterBuilderPlugin - Interface in springfox.documentation.spi.service
- ParameterContext - Class in springfox.documentation.spi.service.contexts
- ParameterContext(ResolvedMethodParameter, DocumentationContext, GenericTypeNamingStrategy, OperationContext, int) - Constructor for class springfox.documentation.spi.service.contexts.ParameterContext
- ParameterDataTypeReader - Class in springfox.documentation.spring.web.readers.parameter
- ParameterDataTypeReader(SchemaPluginsManager, TypeNameExtractor, EnumTypeDeterminer, ModelSpecificationFactory) - Constructor for class springfox.documentation.spring.web.readers.parameter.ParameterDataTypeReader
- ParameterDefaultReader - Class in springfox.documentation.spring.web.readers.parameter
- ParameterDefaultReader(DescriptionResolver) - Constructor for class springfox.documentation.spring.web.readers.parameter.ParameterDefaultReader
- ParameterExpansionContext - Class in springfox.documentation.spi.service.contexts
- ParameterExpansionContext(String, String, String, ParameterMetadataAccessor, DocumentationType, ParameterBuilder, RequestParameterBuilder) - Constructor for class springfox.documentation.spi.service.contexts.ParameterExpansionContext
- parameterIndex(int) - Method in class springfox.documentation.builders.RequestParameterBuilder
- ParameterMapper - Class in springfox.documentation.swagger2.mappers
-
Deprecated.
- ParameterMapper() - Constructor for class springfox.documentation.swagger2.mappers.ParameterMapper
-
Deprecated.
- 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 - Class in springfox.documentation.swagger1.readers.parameter
- ParameterNameReader() - Constructor for class springfox.documentation.spring.web.readers.parameter.ParameterNameReader
- ParameterNameReader() - Constructor for class springfox.documentation.swagger1.readers.parameter.ParameterNameReader
- parameterNotBlank() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
- 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
-
Deprecated.
- parameterSize() - Method in class springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration
- ParameterSpecification - Class in springfox.documentation.service
- ParameterSpecification(SimpleParameterSpecification, ContentSpecification) - Constructor for class springfox.documentation.service.ParameterSpecification
- ParameterSpecificationContext - Class in springfox.documentation.builders
- ParameterSpecificationContext(String, ParameterType, Collection<MediaType>, SimpleParameterSpecification, ContentSpecification, SimpleParameterSpecificationBuilder, ContentSpecificationBuilder) - Constructor for class springfox.documentation.builders.ParameterSpecificationContext
- parameterSpecificationProvider(ParameterSpecificationProvider) - Method in class springfox.documentation.builders.RequestParameterBuilder
- ParameterSpecificationProvider - Interface in springfox.documentation.builders
- parameterStyle(ParameterStyle) - Method in class springfox.documentation.oas.mappers.ServiceModelToOpenApiMapper
- ParameterStyle - Enum in springfox.documentation.service
- parameterType(String) - Method in class springfox.documentation.builders.ParameterBuilder
-
Deprecated.
- parameterType(ParameterType) - Method in class springfox.documentation.builders.ParameterBuilder
-
Deprecated.Updates the type of parameter
- ParameterType - Enum in springfox.documentation.service
- 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
- parent(ModelSpecification) - Method in class springfox.documentation.oas.mappers.ModelSpecificationInheritanceDeterminer
- parent(ModelSpecification) - Method in class springfox.documentation.swagger2.mappers.ModelSpecificationInheritanceDeterminer
- parse(String) - Static method in class springfox.documentation.common.Version
-
Parses the given string representation of a version into a
Version
object. - PASSWORD - Static variable in class springfox.documentation.schema.ScalarType
- path(String) - Method in class springfox.documentation.builders.ApiDescriptionBuilder
-
Updates the path to the api operation
- PATH - springfox.documentation.service.ParameterType
- PathAdjuster - Interface in