Springboot整合Swagger UI 3.0.0 版本

一、前言

在之前的项目中，以及提到了如何整合 Swagger UI 2 版本，包括导入jar包，编写配置文件，以及需要对应的springboot版本等。
链接如下：https://blog.youkuaiyun.com/qq_42102911/article/details/123295890

今天学习如何整合最新的swagger版本：Swagger UI 3.0.0。

二、实现过程

1.导入依赖

注意区别：在2.0版本，需要导入2个jar包，而在3.0版本，只需要导入一个jar包。

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>3.0.0</version>
</dependency>

注意：我使用的springboot版本是2.7.2.

2.编写配置文件

注意：@EnableWebMvc，需要添加该注解，否则，启动项目会报错。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
@EnableWebMvc
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                /**
                 * 重点说明:
                 * 其余都是可以默认,但是controller扫描的路径一定要该队,是该项目的controller包路径
                 */
                .apis(RequestHandlerSelectors.basePackage("com.janson.test.controller"))
                //.paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                /**
                 * 指定项目的名称和主题
                 */
                .title("某某某系统")
                /**
                 * 描述项目的用途
                 */
                .description("某某某系统后端接口")
                /**
                 * name:使用者的姓名
                 * url:使用者的相关技术文章
                 * email:使用者的邮箱地址
                 */
                .contact(new Contact("janson", "http://www.baidu.com", "zdh@data.com"))
                .version("1.0")
                .build();
    }
}

3.启动项目

访问链接如下：http://localhost:8095/swagger-ui/index.html