spring-boot 禁用swagger的方法
在使用spring-boot开发的时候,我们很多时候会使用swagger作为api文档输出。可以在UI界面上看到api的路径,参数等等。
当然,作为开发环境是很方便的,但是上生产环境的时候,我们需要把swagger禁掉。怎么通过配置文件的方法来禁用swagger呢?
代码如下:
importorg.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
importorg.springframework.context.annotation.Bean;
importorg.springframework.context.annotation.Configuration;
importspringfox.documentation.builders.ApiInfoBuilder;
importspringfox.documentation.builders.ParameterBuilder;
importspringfox.documentation.builders.RequestHandlerSelectors;
importspringfox.documentation.schema.ModelRef;
importspringfox.documentation.service.Parameter;
importspringfox.documentation.spi.DocumentationType;
importspringfox.documentation.spring.web.plugins.Docket;
importspringfox.documentation.swagger2.annotations.EnableSwagger2;
importjava.util.ArrayList;
importjava.util.List;
/**
*CreatedbyBane.Shi.
*User:Bane.Shi
*Date:2017/12/28
*Time:下午2:15
*/
@Configuration
@ConditionalOnProperty(prefix="swagger",value={"enable"},havingValue="true")
@EnableSwagger2
publicclassSwaggerConfiguration{
@Bean
publicDocketswagger(){
returnnewDocket(DocumentationType.SWAGGER_2)
.groupName("default")
.apiInfo(newApiInfoBuilder().title("SSPSchoolAPI").version("1.0.0").build())
.select()
.apis(RequestHandlerSelectors.basePackage("com.fclassroom.ssp.school"))
.build()
.globalOperationParameters(globalOperationParameters());
}
privateListglobalOperationParameters(){
Listparameters=newArrayList<>();
//parameters.add(newParameterBuilder().name("ACCESS-TOKEN").description("ACCESS-TOKEN").required(false).parameterType("header").modelRef(newModelRef("string")).build());
returnparameters;
}
}
如果要开启swagger,在配置文件中加上
swagger.enable=true
关键就是这里的@ConditionalOnProperty
这里的属性key是swagger.enable,havingValue是期望值,只有在值等于期望值的时候,才会生效。也就是说,swagger.enable只能为true的时候才会生效,其他值或不设值,都不会生效的。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持毛票票。