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的资料请关注脚本之家其它相关文章!

相关文章

  • jdk中密钥和证书管理工具keytool常用命令详解

    jdk中密钥和证书管理工具keytool常用命令详解

    keytool JAVA是个密钥和证书管理工具。它使用户能够管理自己的公钥/私钥对及相关证书,用于(通过数字签名)自我认证(用户向别的用户/服务认证自己)或数据完整性以及认证服务
    2014-01-01
  • Elasticsearch percolate 查询示例详解

    Elasticsearch percolate 查询示例详解

    这篇文章主要为大家介绍了Elasticsearch percolate 查询示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-01-01
  • 基于java中反射的总结分析

    基于java中反射的总结分析

    所谓反射,就是根据一个已经实例化了的对象来还原类的完整信息
    至少对我而言,我认为它带给我的好处是,让我从下往上的又了解了一遍面向对象

    2013-05-05
  • Spring中@RestController和@Controller的使用及区别

    Spring中@RestController和@Controller的使用及区别

    这篇文章主要介绍了Spring中@RestController和@Controller的使用及区别,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2025-03-03
  • Spring Boot中优雅地处理参数传递的技巧分享

    Spring Boot中优雅地处理参数传递的技巧分享

    最近一直在学习Spring Boot,今天将其中的从前台过来的参数传递总结一下,下面这篇文章主要给大家介绍了关于Spring Boot中优雅地处理参数传递的技巧,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-05-05
  • 通过Java实现获取表的自增主键值

    通过Java实现获取表的自增主键值

    这篇文章主要为大家详细介绍了如何通过Java实现获取表的自增主键值,文中的示例代码讲解详细,具有一定的学习价值,感兴趣的可以了解一下
    2023-06-06
  • @Transaction,@Async在同一个类中注解失效的原因分析及解决

    @Transaction,@Async在同一个类中注解失效的原因分析及解决

    这篇文章主要介绍了@Transaction,@Async在同一个类中注解失效的原因分析及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • SpringBoot微服务注册分布式Consul的详细过程

    SpringBoot微服务注册分布式Consul的详细过程

    这篇文章主要介绍了SpringBoot(微服务)注册分布式Consul,Spring Boot应用可以通过向Consul注册自身来实现服务发现和治理,使得其他服务可以在Consul中发现并调用它,需要的朋友可以参考下
    2023-04-04
  • SpringCloud Feign请求头删除修改的操作代码

    SpringCloud Feign请求头删除修改的操作代码

    这篇文章主要介绍了SpringCloud Feign请求头删除修改,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-03-03
  • Springboot配置AOP的注解切点失效解决方案

    Springboot配置AOP的注解切点失效解决方案

    本文探讨了在Spring框架中使用AOP拦截静态方法调用的实现细节,重点在于ApplicationContext和ApplicationContextAware接口的使用差异,通过对比两种获取Bean的方式,最终解决了切点无法被拦截的问题
    2026-06-06

最新评论