SpringBoot任意版本集成Swagger各种版本的操作指南

 更新时间:2024年07月11日 11:09:58   作者:ℋᙚᵐⁱᒻᵉ鲸落  
在学习Swagger生成API文档的时候经常会遇到问题,而目前市面上大部分技术分享者的SpringBoot版本并没和我们的同步,导致一些一模一样的代码,在我们的项目上却无法使用,这是一个经常性的问题,本文章就旨在和大家搞定SpringBoot任意版本集成Swagger各种版本

引言:喜欢自学的新手们,在学习Swagger生成API文档的时候经常会遇到问题,而目前市面上大部分技术分享者的SpringBoot版本并没和我们的同步,导致一些一模一样的代码,在我们的项目上却无法使用,这是一个经常性的问题,本文章就旨在和大家列举几种常用的项目搭配,来解决访问网址:http://localhost:8080/swagger-ui/index.html 报错“Error Page”的问题。

首先声明一下使用 Spring Boot 2.7 及以上版本时,Swagger 2.9.2会有一些兼容性问题,很有可能在项目运行前我们就饮恨于此了。

比较常见的几个错误:

1、“org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException”

2、“Failed to start bean 'documentationPluginsBootstrapper'

3、“Caused by: java.lang.NullPointerException: null”。

简单的解决办法: 

版本对应(Maven官方仓库:https://mvnrepository.com/

①SPB(SpringBoot) 2.7 以下 + Swagger-ui 和Swagger2 2.9.2

②SPB(SpringBoot) 2.7 往上 + springfox-boot-starter(3.0.0包括Swagger-ui 和Swagger2 3.0.0)

直接改用Springdoc OpenAPI

补充性说明

一、低版本过程性搭建

1、依赖展示

<properties>
 
//……省略
    <spring-boot.version>2.5.3</spring-boot.version>
</properties>
  //……省略
 
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-dependencies</artifactId>
    <version>${spring-boot.version}</version>  
    <type>pom</type>
    <scope>import</scope>
</dependency>
 
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
 
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

2、配置Swagger

(1)最小环境搭建

*注意低版本url:http://localhost:8080/swagger-ui.html

*注意高版本url:http://localhost:8080/swagger-ui/index.html

​​​​​​​import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
@EnableSwagger2
@Configuration  // 注入spring boot
public class SwaggerConfig {
 
} // 只用这几行代码就可以运行

二、高版本过程性搭建

1、依赖展示

//……省略
<spring-boot.version>2.7.6</spring-boot.version>
// ……省略
<dependency>  
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

2、配置Swagger

(1)最小环境搭建

重要:修改配置文件!修改配置文件!修改配置文件!重要的事说三遍!!!

# application.properties写法
 
# Spring Boot 2.6.X版本引入了新的路径匹配策略,这导致了与Springfox的不兼容。
# Spring Boot使用PathPatternMatcher作为默认的路径匹配策略,而Springfox依赖于
# AntPathMatcher。所以做以下修改:
spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER

*注意低版本url:http://localhost:8080/swagger-ui.html

*注意高版本url:http://localhost:8080/swagger-ui/index.html

import org.springframework.context.annotation.Configuration;
import springfox.documentation.oas.annotations.EnableOpenApi;
 
@EnableOpenApi	// config文件只改变了这里哦
@Configuration  // 注入spring boot
public class SwaggerConfig {
 
}

三、Springdoc OpenAPI高低环境搭建

得多皮才非得高配低、低配高啊?我可没这闲工夫再写了,上面两种解决方法自己排列组合试去吧

四、配置Swagger

以上所有SwaggerConfig配置类都是默认情况,下面简单分享一下自定义配置项。

@EnableOpenApi
@Configuration  // 注入spring boot
public class SwaggerConfig {
    @Bean   // 要想配置生效必须注入
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo()
    {
        return new ApiInfoBuilder()
                .title("Spring Boot2.7.6中使用Swagger3.0.0构建RESTful APIs")
                .description("我可是描述信息哈~~更多Spring Boot相关文章请关注:http://blog.didispace.com/")
                .version("8.0")
                .build();
    }
}

以上就是SpringBoot任意版本集成Swagger各种版本的操作指南的详细内容,更多关于SpringBoot集成Swagger的资料请关注脚本之家其它相关文章!

相关文章

  • SpringBoot项目中java -jar xxx.jar没有主清单属性的解决方法

    SpringBoot项目中java -jar xxx.jar没有主清单属性的解决方法

    这篇文章主要给大家介绍了SpringBoot项目中java -jar xxx.jar没有主清单的解决方法,文中通过代码示例给大家介绍的非常详细,对大家的学习或工作有一定的帮助,需要的朋友可以参考下
    2024-01-01
  • Java concurrency之非公平锁_动力节点Java学院整理

    Java concurrency之非公平锁_动力节点Java学院整理

    本篇文章主要介绍了Java concurrency之非公平锁,详细的介绍了获取和释放非公平锁,有兴趣的同学可以了解一下
    2017-06-06
  • Java Web实战之使用三层架构与Servlet构建登录注册模块

    Java Web实战之使用三层架构与Servlet构建登录注册模块

    这篇文章介绍了如何使用三层架构(View, Service, DAO)和JDBCTemplate技术在JavaWeb环境下实现登录和注册功能,详细说明了构建项目的步骤,包括创建数据库表、实体类、DAO层、Service层、Servlet处理及页面设计,需要的朋友可以参考下
    2024-10-10
  • 使用Spring的StopWatch实现代码性能监控的方法详解

    使用Spring的StopWatch实现代码性能监控的方法详解

    在开发过程中,偶尔还是需要分析代码的执行时间,Spring 框架提供了一个方便的工具类 StopWatch,本文将介绍 StopWatch 的基本用法,并通过示例演示如何在项目中使用 StopWatch 进行代码性能监控
    2023-12-12
  • java8使用流的filter来筛选数据的实现

    java8使用流的filter来筛选数据的实现

    这篇文章主要介绍了java8使用流的filter来筛选数据,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-03-03
  • Java之ThreadLocal使用常见和方式案例讲解

    Java之ThreadLocal使用常见和方式案例讲解

    这篇文章主要介绍了Java之ThreadLocal使用常见和方式案例讲解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-08-08
  • Java实现bmp和jpeg图片格式互转

    Java实现bmp和jpeg图片格式互转

    本文主要介绍了Java实现bmp和jpeg图片格式互转,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-04-04
  • Spring Core动态代理的实现代码

    Spring Core动态代理的实现代码

    通过JDK的Proxy方式或者CGLIB方式生成代理对象的时候,相关的拦截器已经配置到代理对象中去了,接下来通过本文给大家介绍Spring Core动态代理的相关知识,需要的朋友可以参考下
    2021-10-10
  • java 判断两个时间段是否重叠的案例

    java 判断两个时间段是否重叠的案例

    这篇文章主要介绍了java 判断两个时间段是否重叠的案例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08
  • 完美解决springboot中使用mybatis字段不能进行自动映射的问题

    完美解决springboot中使用mybatis字段不能进行自动映射的问题

    今天在springboot中使用mybatis的时候不能字段不能够进行自动映射,接下来给大家给带来了完美解决springboot中使用mybatis字段不能进行自动映射的问题,需要的朋友可以参考下
    2023-05-05

最新评论