本篇文章为大家展示了Java中怎么利用Swagger配置扫描接口,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。
1. Swagger--配置扫描接口及开关
1.1 配置扫描接口
SwaggerConfig.java
@Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.tian.swagger.controller")).build(); }
运行结果(因为现在只扫描了com.tian.swagger.controller 的包 所以只会有一个HelloController):
1.2 配置接口扫描过滤
SwaggerConfig.java
@Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.tian.swagger.controller")).paths(PathSelectors.ant("/tian @Bean public Docket docket() { // enable(boolean) 表示是否启用Swagger 默认为true(启用) 如果为false,则Swagger不能在游览器中访问 return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).enable(false).select().apis(RequestHandlerSelectors.basePackage("com.tian.swagger.controller")).paths(PathSelectors.ant("/tian @Bean // org.springframework.core.env.Environment public Docket docket(Environment environment) { // 设置要显示swagger的环境 这里是 dev 和 test 环境 // org.springframework.core.env.Profiles Profiles profiles = Profiles.of("dev", "test"); // 判断当前是否处于该环境 // 通过 enable() 接收此参数判断是否要显示 boolean flag = environment.acceptsProfiles(profiles); // enable(boolean) 表示是否启用Swagger 默认为true(启用) 如果为false,则Swagger不能在游览器中访问 return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).enable(flag).select().apis(RequestHandlerSelectors.basePackage("com.tian.swagger.controller")).paths(PathSelectors.ant("/tian/**")).build(); }
启动测试01:Profiles 里面包含 dev
启动测试01:Profiles 里面不包含 dev
Profiles profiles = Profiles.of("test");
上述内容就是Java中怎么利用Swagger配置扫描接口,你们学到知识或技能了吗?如果还想学到更多技能或者丰富自己的知识储备,欢迎关注编程网行业资讯频道。