springboot--Swagger依赖

本文介绍了如何在SpringBoot项目中集成Swagger2,并解决Swagger2中Long类型默认值导致的异常问题。通过引入特定版本的springfox-swagger2、springfox-swagger-ui以及swagger的annotations和models库,确保UI界面的正常显示并避免类型转换错误。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

依赖说明:

  1.         <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
  2.         <dependency>
  3.             <groupId>io.springfox</groupId>
  4.             <artifactId>springfox-swagger2</artifactId>
  5.             <version>2.9.2</version>
  6.             <!-- Long类型的默认值是字符串,控制台会打印异常,替换为1.5.21版本 -->
  7.             <exclusions>
  8.                 <exclusion>
  9.                     <groupId>io.swagger</groupId>
  10.                     <artifactId>swagger-annotations</artifactId>
  11.                 </exclusion>
  12.                 <exclusion>
  13.                     <groupId>io.swagger</groupId>
  14.                     <artifactId>swagger-models</artifactId>
  15.                 </exclusion>
  16.             </exclusions>
  17.         </dependency>
  18.         <dependency>
  19.             <groupId>io.springfox</groupId>
  20.             <artifactId>springfox-swagger-ui</artifactId>
  21.             <version>2.9.2</version>
  22.         </dependency>
  23.         <dependency>
  24.           <groupId>io.swagger</groupId>
  25.           <artifactId>swagger-annotations</artifactId>
  26.           <version>1.5.21</version>
  27.         </dependency>
  28.         <dependency>
  29.           <groupId>io.swagger</groupId>
  30.           <artifactId>swagger-models</artifactId>
  31.           <version>1.5.21</version>
  32.         </dependency>

        Swagger2比1的版本UI有了很大改善,于是入坑。之所以使用1.5.21的annotations和model,原因是Long类型的数据默认填充的是"",会导致类型转换异常,也可以设置example值
 

### 如何在 Spring Boot 中集成 Swagger #### 添加依赖项 为了使 Spring Boot 项目能够支持 Swagger,需向项目的 `pom.xml` 文件中添加相应的 Maven 依赖。对于 Spring Boot 版本 3.x 及更高版本而言,推荐使用 `springdoc-openapi-starter-webmvc-ui` 来替代旧版的 swagger 相关库。 ```xml <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.0.2</version><!-- 确认此版本兼容当前使用的Spring Boot版本 --> </dependency> ``` #### 配置应用属性文件 通常情况下,默认设置已经足够让 Swagger 正常工作;然而如果想要自定义路径或者其他行为,则可以在 application.properties 或者 application.yml 文件里加入特定参数: ```properties # application.properties 示例 springdoc.api-docs.path=/v3/api-docs springdoc.swagger-ui.path=/swagger-ui.html ``` #### 启动并验证 完成上述操作之后重新编译运行程序,在浏览器地址栏输入如下链接即可打开 Swagger UI 页面浏览 API 文档[^1]。 http://localhost:8080/swagger-ui/index.html #### 更复杂的场景处理 当遇到更加复杂的应用需求时——比如安全机制设定或是多个 API 组管理等方面的要求,应当查阅 springdoc-openapi 官方指南获取更多指导信息以便做出适当调整[^3]。 ```java // Java代码片段用于展示如何通过@Bean注解注册组件 import org.springframework.context.annotation.Bean; ... @Bean public OpenAPI customOpenAPI(){ return new OpenAPI() .info(new Info().title("Sample Application API").description("This is a sample Spring Boot RESTful service using springdoc-openapi and OpenAPI 3.").version("v0.0.1")); } ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值