SpringBoot中集成swagger3（OpenAPI）

SpringBoot中集成swagger3（OpenAPI）

步骤概括：

1. 导入swagger3 的依赖。
2. SpringBoot版本高于2.4or2.5，在application.yml配置文件中增加mvc配置。
3. 定义swagger配置类。
4. 开始使用。

step1.

在pom.xml中导入swagger3的相关依赖。

   <!--引入swagger 3-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

如果使用swagger自带ui界面，那么这一个依赖就能够满足需求了。但是想要界面UI元素更丰富一点，可以添加一个UI的依赖，如下：

     <!--swagger ui  -->
        <!--usage: 直接引入这个依赖，重新启动项目即可，访问地址为项目地址/doc.html-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>2.0.9</version>
        </dependency>

引入这个依赖不需要做任何配置，只需要在启动项目的时候，访问地址变为 ： /doc.html 即可。

step2.

步骤2在低版本SpringBoot中不用进行配置，在高版本SpringBoot中，如果不进行mvc路径配置，则会报错，报错为：

Failed to start bean ‘documentationPluginsBootstrapper’; nested exception is java.lang.NullPointerException

解决这个报错，只需要在 application.yml中配置mvc路径匹配模式即可

  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

step3.

自定义配置类 config/SwaggerConfig.java

@Configuration
@EnableOpenApi
public class SwaggerConfig {
   
   
    @Bean
    public Docket api()