[Java知识库]Springboot2 Swagger3 集成

一、默认UI

1. 版本尝鲜

Swagger3在Swagger2的基础上进行了部分升级， 使用和Swagger2没有多少区别。

一个重要的优化是依赖的引入，由之前的多个依赖变更为一个依赖，跟随springboot-starter风格，同时引入了新的开关注解 @EnableOpenApi 以代替@EnableSwagger2 。

因此，集成工作变得更加的简便了，必要工作只有两个，添加swagger3的starter依赖包，在springboot主程序类添加@EnableOpenApi开关注解。

2. 导入依赖

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
    </dependencies>

3. 配置Swagger

(必选)添加开关注解@EnableOpenApi

@SpringBootApplication
@EnableOpenApi
public class DemoSwagger3Application {

    public static void main(String[] args) {
        SpringApplication.run(DemoSwagger3Application.class, args);
    }

}

4. Docket配置

(可选)自定义首页属性 Docket配置

/**
 * @author gblfy
 */
@Configuration
public class SwaggerConfig {
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.OAS_30).apiInfo(
                new ApiInfoBuilder()
                        .contact(new Contact("gblfy", "gblfy.com", "gblfy002@163.com"))
                        .title("Swagger3测试项目")
                        .build()
        );
    }
}

4.访问路径

输入访问路径:
http://localhost:8080/swagger-ui/index.html

二、bootstrapUI

2.1. 导入依赖

  <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

2.2. 访问地址

http://localhost:8080/doc.html