Deprecated API

Contents

• Interfaces
• Classes
• Annotation Types
• Fields
• Methods
• Constructors

Interfaces

Interface	Description
springfox.documentation.schema.ModelProvider
springfox.documentation.schema.ModelReference

Classes

Class	Description
springfox.documentation.builders.ModelBuilder
springfox.documentation.builders.ParameterBuilder
springfox.documentation.builders.ResponseMessageBuilder
springfox.documentation.schema.DefaultModelProvider
springfox.documentation.schema.Model
springfox.documentation.schema.ModelProperty
springfox.documentation.schema.ModelRef
springfox.documentation.schema.Types	use @see ScalarType instead
springfox.documentation.service.Parameter
springfox.documentation.service.ResponseMessage	- Use @see Response instead going forward
springfox.documentation.spring.web.scanners.ApiModelReader
springfox.documentation.swagger1.mappers.DataTypeMapper
springfox.documentation.swagger2.mappers.ModelMapper
springfox.documentation.swagger2.mappers.ParameterMapper
springfox.documentation.swagger2.mappers.SerializableParameterFactories

Annotation Types

Annotation Type	Description
springfox.documentation.swagger2.annotations.EnableSwagger2WebFlux
springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc

Fields

Field	Description
springfox.documentation.spi.DocumentationType.SPRING_WEB

Methods

Method	Description
springfox.documentation.builders.AlternateTypeBuilder.property(AlternateTypePropertyBuilder)
springfox.documentation.builders.AlternateTypeBuilder.withAnnotations(List<Annotation>)
springfox.documentation.builders.AlternateTypeBuilder.withProperties(List<AlternateTypePropertyBuilder>)
springfox.documentation.builders.AlternateTypePropertyBuilder.withAnnotations(List<Annotation>)
springfox.documentation.builders.AlternateTypePropertyBuilder.withCanRead(boolean)
springfox.documentation.builders.AlternateTypePropertyBuilder.withCanWrite(boolean)
springfox.documentation.builders.AlternateTypePropertyBuilder.withName(String)
springfox.documentation.builders.AlternateTypePropertyBuilder.withType(Class<?>)
springfox.documentation.builders.AuthorizationCodeGrantBuilder.tokenEndpoint(TokenEndpoint)
springfox.documentation.builders.AuthorizationCodeGrantBuilder.tokenRequestEndpoint(TokenRequestEndpoint)
springfox.documentation.builders.DocumentationBuilder.resourceListing(ResourceListing)
springfox.documentation.builders.ExampleBuilder.withDescription(String)
springfox.documentation.builders.ExampleBuilder.withExternalValue(String)
springfox.documentation.builders.ExampleBuilder.withId(String)
springfox.documentation.builders.ExampleBuilder.withSummary(String)
springfox.documentation.builders.OperationBuilder.parameters(List<Parameter>)
springfox.documentation.builders.OperationBuilder.responseMessages(Set<ResponseMessage>)
springfox.documentation.builders.OperationBuilder.responseModel(ModelReference)
springfox.documentation.builders.ParameterBuilder.parameterType(String)
springfox.documentation.builders.SimpleParameterSpecificationBuilder.collectionFormat(CollectionFormat)
springfox.documentation.RequestHandler.declaringClass()
springfox.documentation.RequestHandler.getHandlerMethod()	This is introduced to preserve backwards compat
springfox.documentation.RequestHandler.getRequestMapping()	This is introduced to preserve backwards compat
springfox.documentation.schema.plugins.SchemaPluginsManager.model(ModelContext)
springfox.documentation.schema.plugins.SchemaPluginsManager.property(ModelPropertyContext)
springfox.documentation.schema.plugins.SchemaPluginsManager.syntheticModel(ModelContext)
springfox.documentation.schema.plugins.SchemaPluginsManager.syntheticProperties(ModelContext)
springfox.documentation.schema.property.ModelPropertiesProvider.propertiesFor(ResolvedType, ModelContext)
springfox.documentation.service.Operation.getResponseMessages()
springfox.documentation.service.Operation.getResponseModel()
springfox.documentation.spi.schema.contexts.ModelContext.getBuilder()
springfox.documentation.spi.schema.contexts.ModelPropertyContext.getBuilder()	Use ModelPropertyContext.getSpecificationBuilder() instead
springfox.documentation.spi.service.contexts.Defaults.defaultResponseMessages()
springfox.documentation.spi.service.contexts.DocumentationContext.getGlobalRequestParameters()	use @see DocumentationContext.getGlobalParameters() instead
springfox.documentation.spi.service.contexts.DocumentationContextBuilder.defaultResponseMessages(Map<RequestMethod, List<ResponseMessage>>)
springfox.documentation.spi.service.contexts.OperationContext.getGlobalOperationParameters()
springfox.documentation.spi.service.contexts.ParameterContext.methodParameter()	Use ParameterContext.resolvedMethodParameter() instead
springfox.documentation.spi.service.contexts.ParameterContext.parameterBuilder()
springfox.documentation.spi.service.contexts.ParameterExpansionContext.getField()
springfox.documentation.spi.service.contexts.SecurityContextBuilder.forHttpMethods(Predicate<HttpMethod>)
springfox.documentation.spi.service.contexts.SecurityContextBuilder.forPaths(Predicate<String>)
springfox.documentation.spi.service.DefaultsProviderPlugin.create(DocumentationType)
springfox.documentation.spring.web.plugins.Docket.globalOperationParameters(List<Parameter>)
springfox.documentation.spring.web.plugins.Docket.globalResponseMessage(RequestMethod, List<ResponseMessage>)
springfox.documentation.swagger.web.SecurityConfiguration.getApiKey()
springfox.documentation.swagger.web.SecurityConfiguration.getApiKeyName()
springfox.documentation.swagger.web.SecurityConfiguration.getApiKeyVehicle()
springfox.documentation.swagger.web.SwaggerResource.getLocation()
springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper.mapResponseMessages(Set<ResponseMessage>)

Constructors

Constructor	Description
springfox.documentation.builders.AlternateTypePropertyBuilder()
springfox.documentation.schema.Example(Object)
springfox.documentation.service.ApiInfo(String, String, String, String, String, String, String)
springfox.documentation.swagger.web.SecurityConfiguration(String, String, String, String, String, ApiKeyVehicle, String, String)