SpringBoot集成Swagger2

一、SpringBoot集成Swagger2

1.1、导入两个springfox的jar包

• Springfox-Swagger2
• Swagger-Springmvcs

二、使用Swagger

要求：jdk 1.8 + 否则Swagger2无法运行

步骤：

2.1、新建一个SpringBoot-web项目

2.2、添加Maven依赖

<!-- 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>

2.3、编写HelloController，测试确保运行成功！

2.4、要使用Swagger，我们需要编写一个配置类SwaggerConfig来配置 Swagger

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {
     
}

2.5、访问测试 ：http://localhost:8080/swagger-ui.html ，可以看到swagger的界面；

三、配置Swagger

3.1、Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swaggger。

@Configuration //定义Java配置类
@EnableSwagger2 //开启Swagger2
public class SwaggerConfig {
   
    @Bean //配置docket以配置Swagger具体参数
    public Docket docket() {
   
       return new Docket(DocumentationType.SWAGGER_2);
    }
}

3.2、可以通过apiInfo()属性配置文档信息

//配置Swagger的apiInfo信息
    @Bean
    public ApiInfo apiInfo(){
   
        //作者信息
        Contact CONTACT = new Contact("未进化的程序猿", "https://www.cnblogs.com/the-undeveloped-procedural-ape/", "[email protected]");
        return new ApiInfo("未进化的程序猿的Swagger日志", //Swagger文档标题
                           "Api Documentation",//Swagger文档描述
                           "v1.0",//Swagger文档版本号
                           "https://www.cnblogs.com/the-undeveloped-procedural-ape/",//博客地址
                           CONTACT,//作者信息
                           "Apache 2.0",
                           "http://www.apache.org/licenses/LICENSE-2.0",
                           new ArrayList());
    }

3.3、Docket 实例关联上 apiInfo()

@Bean
public Docket docket() {
   
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(