SpringBoot整合Swagger2遇到的问题

最新推荐文章于 2025-07-07 18:42:17 发布

原创最新推荐文章于 2025-07-07 18:42:17 发布 · 913 阅读

0 ·

CC 4.0 BY-SA版权

本文档介绍如何在Spring Boot项目中集成Swagger2，并提供详细的配置步骤与注意事项。包括推荐的Swagger2版本、配置类详解、接口注解的使用方法等。

需要查看完整教程请移步：http://blog.didispace.com/springbootswagger2/

1.不建议使用2.5.2版本以下的swagger2，对有些服务无法兼容支持，例：

在controller中使用注入Feign的方式调用eureka服务时

本人使用的是2.7.0的版本

2. swagger2的配置类

title:为 Swagger ui.html展示的标题

description：为描述详情

termsOfServiceUrl ：是一个连接地址

contact：是创建者的详情，包含名称等

version：为版本号

apis：这里配置的是你的完整项目名，不能配置错误，不然无法扫描到正确的控制器加载文档

在控制层接口上添加注解@ApiOpration 说明这个接口的描述有 value 及 notes

若有多个参数的情况下，需用注解@ApiImplicitParams（{@ApiImplicitParam(),...}）说明参数

@ApiImplicitParam 有 name（入参的名字） , value(入参的描述) , required(约束) ，dataType（数据类型），ParamType(入参获取方式) 目前已知：属性 path ，实体类 body

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

意志焚烧

关注关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
3
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

spring boot实战之集成swagger2

蛐蛐的博客

12-21

282

目前spring boot并没有集成swagger2的starter，需要手动配置集成一、引入依赖使用gradle引入依赖 compile('org.springframework.boot:spring-boot-starter-web:2.2.2.RELEASE') compile group: 'io.springfox', name: 'springfo...

springboot集成swagger2遇到的问题及解决方法

邓邓子的博客

01-06

1506

1、报错“Failed to start bean ‘documentationPluginsBootstrapper’; nested exception is java.lang.NullPointerException” Exception encountered during context initialization - cancelling refresh attempt: org.springframework.context.ApplicationContextException: Fai

3 条评论您还未登录，请先登录后发表或查看评论

SpringBoot集成swagger2

m0_37730948的博客

04-20

807

在当今前后端框架流行的时代，一个完整并且规范的接口文档是必不可少的。Swagger是一款Restful接口风格文档在线自动生成、接口功能测试的集成插件，用于生成、描述和可视化Restful风格的Web服务。软件可以实现接口文档同API始终保持同步。同过去的离线接口文档相比起来，整体提高了项目的开发效率，减少了前后端成员之间的非必要沟通。官网地址：https://swagger.io/

springboot整合swagger

04-27

springboot整合swagger

SpringBoot整合Swagger超详细完整指南

最新发布

weixin_51040479的博客

07-07

1787

本文详细介绍了Swagger在SpringBoot项目中的完整应用指南，主要内容包括：技术选型与版本对比：比较Springfox与SpringDoc两种实现方案，并提供版本兼容性矩阵项目配置：详细的环境准备与项目结构设计 Maven依赖配置示例多环境（开发/生产）配置文件说明核心功能实现：基础配置类与Web配置类详解完整的注解系统指南（Controller/实体类/枚举类）实体建模与数据传输设计模式（DTO/VO/统一响应）企业级实践：用户管理和认证控制器的完整示例安全认证配置（JWT

Springboot集成Swagger2错误

weixin_45496725的博客

02-11

326

Springboot 集成 swagger2 的错误

SpringBoot集成Swagger2页面无法访问情况

TrayLei的博客

07-10

8621

Spring Boot 集成 Swagger2 之后会有访问失败情况，比如：翻译出来就是解决方法，开启Swagger2 第一、在SpringBootApplication启动类上加上@EnableSwagger2注解第二、创建一个Swagger的配置类，加上 @Configuration 和 @EnableSwagger2 基本上来说一般访问失败都是没有开启Swagger导致的。接下来就是其他过滤器拦截器等等导致的失败问题重写 ResponseBodyAdvice 的 supports 方法，对Swa

【实战场景】SpringBoot整合Swagger快速实现

杰叔叔不是个好叔叔的博客

08-09

2209

Swagger是一个包含多种工具和库的开源项目，用于支持RESTful API的设计、开发、文档化和测试。Swagger通过Swagger Specification（现为OpenAPI Specification）定义了一套标准化的API描述格式，使得API的文档和描述具有一致性和可重用性。

SpringBoot配置SwaggerUI访问404错误的解决方法

08-28

但是在配置SwaggerUI时，我们可能会遇到404错误的问题。本文将为大家介绍如何解决这个问题。首先，我们需要在pom文件中加入Swagger的依赖，包括springfox-swagger-ui和springfox-swagger2两个依赖项。然后，我们...

SpringBoot整合Swagger3.0时所遇到的问题

m0_46419245的博客

11-28

828

Correct the classpath of your application so that it contains a single, compatible version of org.springframework.plugin.core.PluginRegistry

SpringBoot整合Swagger2

12程序猿的博客

07-15

565

前后端分离后，维护接口文档基本上是必不可少的工作。一个理想的状态是设计好后，接口文档发给前端和后端，大伙按照既定的规则各自开发，开发好了对接上了就可以上线了。当然这是一种非常理想的状态，实际开发中却很少遇到这样的情况，接口总是在不断的变化之中，有变化就要去维护，做过的小伙伴都知道这件事有多么头大！还好，有一些工具可以减轻我们的工作量，Swagger2就是其中之一，至于其他类似功能但是却收费的软件，这里就不做过多介绍了。本文主要和大伙来聊下在Spring Boot中如何整合Swagger2。 1、Swagge

SpringBoot----SpringBoot整合Swagger2

Stephen GS的博客

07-14

283

SpringBoot----SpringBoot整合Swagger2

SpringBoot 集成 Swagger2

asksl的博客

11-29

891

SpringBoot 集成 Swagger2

【SpringBoot整合swagger2】

Azy0619的博客

04-17

171

1、代码变，文档变2、跨语言，支持多种语言3、swagger-ui 呈现出来的是一份可交互式的API文档，可以直接在文档页面尝试API的调用4、可以将文档规范导入相关工具（postman、soapui），这些工具将会为我们自动地创建自动化测试。

Springboot集成Swagger2

qq_40406380的博客

05-14

151

spring boot 整合swagger2

hairunf的博客

08-25

154

这里写自定义目录标题SpingBoot 集成 Swagger2这种做法存在以下几个问题：SpringBoot 集成 Swagger2 swagger是什么？ 1、是一款让你更好的书写API文档的规范且完整框架。 2、提供描述、生产、消费和可视化RESTful Web Service。 3、是由庞大工具集合支撑的形式化规范。这个集合涵盖了从终端用户接口、底层代码库到商业API管理的方方面面。 SpingBoot 集成 Swagger2 在团队开发中，一个好的 API 文档不但可以减少大量的沟通成本，还可以帮助

springboot整合 swagger2

秋叶清风的博客

10-26

284

springboot整合 swagger2 引入依赖  <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version>

SpringBoot之整合Swagger2

qianye的博客

08-24

503

一、Swagger2介绍 Swagger是世界上最大的API开发工具框架，用于OpenAPI规范(OAS)，使整个API生命周期的开发，从设计和文档，到测试和部署。 Swagger从API文档中提取了手工工作，具有一系列用于生成、可视化和维护API文档的解决方案。二、添加Swagger2依赖我这里使用的是Gradle项目自动化构建开源工具 //swagger2 ...

Spring Boot 整合Swagger2

笨小孩的博客

06-12

288

增加Maven 依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.8.0</version> </dependency> <depende

springboot整合swagger2报404

12-27

### 解决 Spring Boot 集成 Swagger2 出现 404 错误的方法当遇到 Spring Boot 应用程序集成 Swagger2 后访问接口文档返回 404 的情况时，可能的原因及对应的解决方案如下： #### 1. 路径匹配策略调整对于某些高版本的 Spring Boot (如 2.6 及以上)，默认路径匹配机制有所变化，这可能导致 Swagger UI 页面无法正常加载。可以在 `application.yml` 文件中指定使用旧版路径匹配器来解决问题。 ```yaml spring: mvc: pathmatch: matching-strategy: ant_path_matcher ``` 此设置确保了与早期版本兼容性[^2]。 #### 2. 添加必要的依赖项确认 pom.xml 中包含了正确的 Swagger 和其他所需库的依赖声明。以下是适用于 Spring Boot 2.x 和 Swagger2 2.9.x 组合的一个典型配置片段： ```xml <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> ``` 这些条目保证了应用程序能够识别并处理来自 Swagger 的请求[^4]。 #### 3. 正确启用 Swagger 功能在主类或任意配置类上添加 `@EnableSwagger2` 注解以激活 Swagger 支持功能。此外，还需定义 Docket Bean 来定制 API 文档的具体行为。 ```java import org.springframework.context.annotation.Bean; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build(); } } ``` 这段代码使得所有控制器中的方法都被纳入到自动生成的 API 文档之中[^3]。 #### 4. 访问 URL 地址校验最后需要注意的是，在浏览器地址栏输入正确的 URL 才能成功打开 Swagger UI 界面，默认情况下应该是类似于 http://localhost:{port}/swagger-ui.html 这样的形式（其中 `{port}` 是应用运行的实际端口号）。如果仍然显示 404，则需进一步排查是否存在防火墙阻止或其他网络层面的问题。