sprintboot中swagger配置,如何禁用生产api接口,开发开发和测试接口?

思路:
配置文件区分添加开启与关闭标识,然后swagger读取boolean值,然后添加判断设置即可。

配置demo如下:

  • pom.xml
    <!--swagger start-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.6.1</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.6.1</version>
    </dependency>

  • 属性配置文件

application-dev.properties 文件:

swagger.show=true

application-prod.properties 文件:

swagger.show=false
  • 代码
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Created by LT on 2019/4.05
 *
 * 访问路径:http://192.168.1.89:8080/demo(项目名称)/swagger-ui.html
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig{

    @Value("${swagger.show}")
    private boolean swaggerShow;
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.demo.bi.controller"))
                // 如果是线上环境,添加路径过滤,设置为全部都不符合
                .paths(swaggerShow==true?PathSelectors.any():PathSelectors.none())
                .build();
    }


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口api")
                .description("内部接口api文档")
                .contact("LT")
                .version("1.0")
                .build();
    }

}

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值