SpringBoot集成Swagger

在项目使用Swagger需要springbox;
         swagger2
         ui

1.新建一个SpringBoot = web项目

2.导入相关依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

3.编写一个hello swagger工程

4.配置swagger --》Config

@Configuration
@EnableSwagger2//开启Swagger2
public class SwaggerConfig {

    //配置了Swagger的Docket的bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
    }

    //配置Swagger信息=apiInfo（覆盖掉默认的基本信息）
    private ApiInfo apiInfo(){
        //作者信息
        Contact contact = new Contact("wll","","");
        return new ApiInfo("标题", "标题测试",
                "1.0", "urn:tos", contact,
                "Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
    }
}

5.运行测试

http://localhost:8080/swagger-ui.html

 

 

注意：

Springboot2.6以后将SpringMVC 默认路径匹配策略从AntPathMatcher 更改为PathPatternParser，导致出错

因此Springboot2.6以后需要在配置文件application.properties中加入以下配置：

spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER

Swagger配置扫描接口

@Configuration
@EnableSwagger2//开启Swagger2
public class SwaggerConfig {

    //配置了Swagger的Docket的bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //RequestHandlerselectors,配置要扫描接口的方式
                //basePackage:指定要扫描的包
                // any():扫描全部
                // none():不扫描
                // withclassAnnotation:扫描类上的注解,参数是一个注解的反射对象
                //withMethodAnnotation:扫描方法上的注解
                .apis(RequestHandlerSelectors.basePackage("com.wll.springbootswagger.controller"))
                //过滤什么路径(以下是只扫描/hello接口)
                .paths(PathSelectors.ant("/hello"))
                .build();

    }

    //配置Swagger信息=apiInfo（覆盖掉默认的基本信息）
    private ApiInfo apiInfo(){
        //作者信息
        Contact contact = new Contact("wll","","");
        return new ApiInfo("标题", "标题测试",
                "1.0", "urn:tos", contact,
                "Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
    }
}

如何让我的Swagger在生产环境中使用，在发布的时候不使用?

  设置一个application-dev.properties和一个application-Pro.properties
  判断是不是生产环境flag = false
  注入enable (flag)

//配置了Swagger的Docket的bean实例
@Bean
public Docket docket(Environment environment){
    //设置要实现的Swagger环境
    Profiles profiles = Profiles.of("dev");
    //获取项目的环境,通过environment.acceptsProfiles判断是否处在自己设定的环境当中
    boolean flag = environment.acceptsProfiles(profiles);

    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .enable(flag) //enable是否启动Swagger，如果为False，则Swagger不能再浏览器中访问
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.wll.springbootswagger.controller"))
            .build();

}

6.配置API文档的分组

.groupName("test")
如何配置多个分组

多个Docket实例即可 

总结:
1.我们可以通过Swagger给一些比较难理解的属性或者接口，增加注释信息

⒉接口文档实时更新

3.可以在线测试

【注意点】在正式发布的时候，关闭Swagger。