Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Methods
• Deprecated Constructors

Deprecated Interfaces

Interface and Description
springfox.documentation.spi.service.ResourceGroupingStrategy @since 2.2.0 - only here for backward compatibility

Deprecated Classes

Class and Description
springfox.documentation.swagger.web.ClassOrApiAnnotationResourceGrouping

Deprecated Methods

Method and Description
springfox.documentation.builders.ApiInfoBuilder.contact(String) @since 2.4.0. Use the overload that takes in a contact instead
springfox.documentation.RequestHandler.declaringClass() @since 2.7.0 This is introduced to preserve backwards compat with groups
springfox.documentation.builders.ModelBuilder.example(String) @since 2.8.1 Use the one which takes in an Object instead
springfox.documentation.builders.ModelPropertyBuilder.example(String) @since 2.8.1 Use the one with Object as parameter
springfox.petstore.controller.PetController.findPetsByTags(String)
springfox.documentation.swagger.web.SecurityConfiguration.getApiKey() @since 2.8.0
springfox.documentation.swagger.web.SecurityConfiguration.getApiKeyName() @since 2.8.0
springfox.documentation.swagger.web.SecurityConfiguration.getApiKeyVehicle() @since 2.8.0
springfox.documentation.swagger.web.UiConfiguration.getApisSorter() @since 2.8.0
springfox.documentation.spi.service.contexts.ParameterExpansionContext.getField() @since 2.8.0
springfox.documentation.RequestHandler.getHandlerMethod() This is introduced to preserve backwards compat
springfox.documentation.swagger.web.SwaggerResource.getLocation() @since 2.8.0 - Use url going forward
springfox.documentation.RequestHandler.getRequestMapping() This is introduced to preserve backwards compat
springfox.documentation.swagger.web.UiConfiguration.getRequestTimeout() @since 2.8.0
springfox.documentation.spi.service.ResourceGroupingStrategy.getResourceDescription(RequestMappingInfo, HandlerMethod) @since 2.0.2
springfox.documentation.spi.service.contexts.DocumentationContext.getResourceGroupingStrategy() @since 2.2.0 - only here for backward compatibility
springfox.documentation.spi.service.ResourceGroupingStrategy.getResourcePosition(RequestMappingInfo, HandlerMethod) @since 2.0.2
springfox.documentation.builders.ResponseMessageBuilder.headers(Map<String, ModelReference>) Use the ResponseMessageBuilder.headersWithDescription(java.util.Map<java.lang.String, springfox.documentation.service.Header>) instead
springfox.documentation.swagger.web.UiConfiguration.isJsonEditor() @since 2.8.0
springfox.documentation.swagger.web.UiConfiguration.isShowRequestHeaders() @since 2.8.0
springfox.documentation.spi.service.contexts.ParameterContext.methodParameter() Use ParameterContext.resolvedMethodParameter() instead
springfox.documentation.spi.service.contexts.SecurityContext.securityForPath(String) SecurityContext.securityForOperation(springfox.documentation.spi.service.contexts.OperationContext)
springfox.documentation.spi.service.contexts.DocumentationContextBuilder.withResourceGroupingStrategy(ResourceGroupingStrategy) @since 2.2.0 - only here for backward compatibility

Deprecated Constructors

Constructor and Description
springfox.documentation.service.ApiDescription(String, String, List<Operation>, Boolean) @since 2.8.1
springfox.documentation.service.ApiInfo(String, String, String, String, String, String, String) @since 2.4.0
springfox.documentation.swagger.web.SecurityConfiguration(String, String, String, String, String, ApiKeyVehicle, String, String) @since 2.8.0. Use the SecurityConfigurationBuilder instead
springfox.documentation.swagger.web.UiConfiguration(String) @since 2.8.0. Use the UiConfigurationBuilder instead
springfox.documentation.swagger.web.UiConfiguration(String, String[]) @since 2.8.0. Use the UiConfigurationBuilder instead
springfox.documentation.swagger.web.UiConfiguration(String, String, String, String, String[], boolean, boolean) @since 2.6.1. Use the UiConfigurationBuilder instead
springfox.documentation.swagger.web.UiConfiguration(String, String, String, String, String[], boolean, boolean, Long) @since 2.8.0. Use the UiConfigurationBuilder instead