引入Swagger

最新推荐文章于 2024-05-12 11:24:08 发布
最新推荐文章于 2024-05-12 11:24:08 发布
阅读量223 收藏
点赞数
分类专栏： java 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/FlyCloudLee/article/details/126134685
版权

1、pom文件引入

<properties>
    <springfox-swagger2-version>2.9.2</springfox-swagger2-version>
</properties>

<!-- swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>${springfox-swagger2-version}</version>
</dependency>

2、启动类上加注解  @EnableSwagger2

springboot项目引入swagger
qq_59534628的博客
04-05 2855
创建项目后，在pom.xml文件中引入 Swagger3 的相关依赖。回忆一下，我们集成 Swagger2 时，引入的依赖如下：而这部分，Swagger2 和 Swagger3 就有所不同了，Swagger2 需要添加两项不同依赖，而 Swagger3 只用添加一项依赖就可以了。
在项目中加入Swagger
最新发布
weixin_64109471的博客
04-22 302
如需操作数据库，也只需引入依赖，添加配置类，在实体类中加入@ApiModel、@ApiModelProperty，在控制类加入@Api、@ApiOperation等几步即可在网站中进行操作，数据库也会有相应结果显示。启动Spring Boot,输入网址（记得在端口号后面加入'/swagger-ui.html'）在实体类中加入@ApiModel、@ApiModelProperty。在控制类加入@Api、@ApiOperation。点击try it out,可出现如下结果。输入内容，并点击execute。
java swagger 引入和配置
zengliguang的专栏
05-12 1292
文件中添加Swagger的相关依赖。请注意，Swagger的配置可能会因版本不同或具体需求而有所变化，确保查阅官方文档或最新版本的指南以获取最准确的信息。确保你的应用能够正确地映射Swagger UI的静态资源。在Spring Boot中，你可能需要在。（针对Springfox 3.0.0及以上版本）注解来启用Swagger配置。完成上述配置后，启动你的应用。Swagger UI通常可以通过。java swagger 引入和配置。（替换为你的应用端口）来访问。在你的API控制器类上使用。
公司已有springboot项目引入swagger
编程技术提升
05-19 1303
官网：https://swagger.io/Swagger 是一个用于生成、描述和调用 RESTful 接口的 Web 服务。通俗的来讲，Swagger 就是将项目中所有（想要暴露的）接口展现在页面上，并且可以进行接口调用和测试的服务。
Spring Boot引入swagger-ui 后swagger-ui.html无法访问404的问题
09-07
首先，要引入Swagger的相关依赖，需要在项目的`pom.xml`文件中添加Springfox的`springfox-swagger2`和`springfox-swagger-ui`两个依赖项，如下所示： ```xml <groupId>io.springfox <artifactId>springfox-...
SpringBoot 项目中引入Swagger2案例.docx
12-09
在 Spring Boot 项目中，Swagger2 是一个强大的工具，它允许开发者轻松地为 RESTful API 创建交互式的文档。Swagger2 提供了一种标准化的方式来描述 API，使得开发者、测试人员和客户端能够更好地理解和使用服务。本...
Springboot引入swagger
qq_44031124的博客
04-07 695
讲在前面：在spring引入swagger时，由于使用的JDK、Spring、swagger 的版本不匹配，导致启动报错，一直存在版本依赖问题。所以在此声明清楚使用版本。
在gradle项目中引入Swagger2产生的依赖冲突问题
TheCalm的博客
06-20 1066
本人是一个gradle小白，在对一个gradle项目进行升级时，由于不熟悉吃了好多亏，改bug都要改吐了。好不容易把项目升级成功，但是却由于想要引入Swagger而又和项目中的guava起了依赖冲突，这就是填了一个坑又挖了一个坑，说多了都是泪啊。 ...
swagger的引入与使用
m0_51660523的博客
09-27 4415
swagger的引入和使用
【Spring-boot】引入Swagger
zhzhl
09-03 214
1, pom文件 &amp;amp;lt;swagger.version&amp;amp;gt;2.7.0&amp;amp;lt;/swagger.version&amp;amp;gt; &amp;amp;lt;!--其他版本EnableSwagger2注解找不到，可能是个例，待验证。--&amp;amp;gt; -------------------------------------------------
Swagger引入及使用
exlinker的博客
11-22 1787
引入依赖（官方依赖） <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.springfox</gr
项目中引入Swagger
weianswer的博客
06-07 3463
swagger测试对于后端来说比postman友好很多，所以在项目中加入swagger配置，便可以用swagger进行测试。 1.首先导入swagger的依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> </dependency>
项目引入Swagger的多种方案
weixin_45655824的博客
06-24 3591
引入Swagger的多种方案 第一种方案： 一、pom文件添加swagger依赖 <!-- swagger依赖 --> <dependency> <groupId>com.spring4all</groupId> <artifactId>swagger-spring-boot-starter</artifactId> &.
SpringBoot如何引入Swagger 在线可视化接口文档。
dsw520的博客
06-04 555
​ 1.swagger介绍： 现在项目都是前后端分离，随着接口越来越多导致接口文档不及时更新或者压根没有接口文档，导致联调的成本增加，Swagger 是为了解决这个问题。 Swagger 是一个规范和完整的框架，用于生成对应的API文档的描述，还能提供在线接口测试的功能。 ...
golang 引入swagger（iris、gin）
weixin_45565886的博客
02-06 4260
golang 引入swagger（iris、gin）
引入swagger报错
03-15
### 解决 Spring Boot 项目中引入 Swagger 报错问题 在 Spring Boot 2.6.x 版本中，由于框架内部机制的变化以及依赖冲突等问题，在引入 `springfox-boot-starter` (即 Swagger 的实现) 后可能会遇到多种报错情况。以下是针对常见报错的解决方案。 #### 常见报错及其原因分析 1. **Failed to start bean ‘documentationPluginsBootstrapper’** 这种错误通常是因为 Spring Boot 2.6.x 默认禁用了 Bean 的循环引用检测功能[^1]。此外，Spring MVC 请求路径匹配器也发生了变化，从 `AntPathMatcher` 转变为 `PathPatternParser`，这可能导致某些旧版 Swagger 配置不兼容[^2]。 2. **NullPointerException 或其他运行时异常** 如果未正确配置 Swagger 或者存在版本不一致的情况，则可能引发 NullPointerException 等运行时异常[^3]。 --- #### 解决方案 ##### 方法一：调整 Maven 依赖并升级版本 确保使用的 `springfox-boot-starter` 是最新稳定版本，并与当前项目的 Spring Boot 版本保持兼容性。例如： ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> ``` 如果仍然存在问题，可以尝试切换到更高版本的 `springfox-boot-starter`，或者考虑使用 OpenAPI 工具替代 Swagger。 ##### 方法二：启用循环引用支持 对于因默认禁用循环引用而导致的问题，可以通过设置属性重新允许循环引用。修改 `application.properties` 文件如下： ```properties spring.main.allow-circular-references=true ``` 此操作可有效解决部分由循环引用引起的启动失败问题。 ##### 方法三：更改 Path Pattern Parser 行为 为了适配新的路径解析逻辑，可以在应用初始化阶段强制恢复至旧版行为 (`AntPathMatcher`)。通过自定义配置类完成这一目标： ```java import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.PathMatchConfigurer; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @Configuration public class WebConfig implements WebMvcConfigurer { @Override public void configurePathMatch(PathMatchConfigurer configurer) { configurer.setUseRegisteredSuffixPatternMatch(true); configurer.useSuffixPatternMatch(false); // 关闭后缀模式匹配 configurer.setPathMatcher(new AntPathMatcher()); // 使用传统方式 } } ``` 上述代码片段将路径匹配器重设为传统的 `AntPathMatcher` 实现。 ##### 方法四：排查 NPE 及其他潜在问题 当发生 NullPointer Exception 时，需重点检查以下几个方面： - 是否遗漏了必要的注解（如 `@EnableSwagger2` 或其等价形式）； - API 文档扫描包范围是否覆盖实际接口所在的模块； - Docket 配置是否存在语法错误或参数缺失。 典型配置示例： ```java import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.service.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration public class SwaggerConfiguration { @Bean public Docket api() { return new Docket(DocumentationType.OAS_30) .apiInfo(apiDetails()) .select() .build(); } private ApiInfo apiDetails() { return new ApiInfoBuilder().title("My Application API").description("Documentation for My App") .version("1.0").build(); } } ``` 以上代码展示了如何创建一个基本的 Docket 对象实例。 --- ### 总结 综合来看，Spring Boot 2.6.x 中集成 Swagger 所产生的各类问题主要源于新特性带来的向后兼容性挑战。通过对依赖管理、核心配置文件调整以及必要扩展手段的应用，能够显著降低此类风险的发生概率。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值