org.minbox.framework.api.boot.autoconfigure.swagger

类 ApiBootSwaggerAutoConfiguration

java.lang.Object

org.minbox.framework.api.boot.autoconfigure.swagger.ApiBootSwaggerAutoConfiguration

@Configuration
 @EnableConfigurationProperties(value=SwaggerProperties.class)
 @ConditionalOnClass(value={springfox.documentation.swagger.configuration.SwaggerCommonConfiguration.class,springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration.class,springfox.documentation.swagger2.web.Swagger2Controller.class})
 @ConditionalOnProperty(prefix="api.boot.swagger",
                       name="enable",
                       havingValue="true",
                       matchIfMissing=true)
 @Import(value={springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration.class,springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration.class})
public class ApiBootSwaggerAutoConfiguration
extends Object

Swagger2自动化配置 只有在设置api.boot.swagger.enable=true时或者在配置文件内不进行配置时（因为默认为true）才会自动化配置该类 通过@Import导入Swagger原本配置类

构造器概要

构造器

构造器和说明
ApiBootSwaggerAutoConfiguration(SwaggerProperties swaggerProperties, org.springframework.beans.factory.BeanFactory beanFactory)

方法概要

限定符和类型	方法和说明
springfox.documentation.service.ApiInfo	apiInfo() 配置文档基本信息 如：文档标题、版本、描述、联系人基本信息等
springfox.documentation.spring.web.plugins.Docket	docket() 配置swagger基本信息 - BasePackage 默认使用SpringBoot项目扫描bean根目录 如果存在配置时则使用SwaggerProperties.basePackage作为扫描根目录

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ApiBootSwaggerAutoConfiguration

public ApiBootSwaggerAutoConfiguration(SwaggerProperties swaggerProperties,
                                       org.springframework.beans.factory.BeanFactory beanFactory)

方法详细资料

docket

@Bean
public springfox.documentation.spring.web.plugins.Docket docket()

配置swagger基本信息 - BasePackage 默认使用SpringBoot项目扫描bean根目录 如果存在配置时则使用SwaggerProperties.basePackage作为扫描根目录

返回:

Docket实例

apiInfo

public springfox.documentation.service.ApiInfo apiInfo()

配置文档基本信息 如：文档标题、版本、描述、联系人基本信息等

返回:

ApiInfo实例