Springboot3.0整合Swagger:从Springfox到Springdoc的迁移指南
2024.01.17 11:46浏览量:26简介:在Springboot 3.0中,Springfox已被废弃,取而代之的是Springdoc。本文将指导您完成从Springfox到Springdoc的迁移,并介绍如何整合Swagger以实现API文档化。
在Spring Boot 3.0中,官方宣布废弃了Springfox库,并推荐使用Springdoc来替代。Springfox是一个用于创建RESTful API文档的开源工具,而Springdoc则提供了对Swagger的官方支持。Swagger是一种规范和完整的框架,用于构建、设计、发布、和使用RESTful Web服务。
本文将指导您完成从Springfox到Springdoc的迁移,并介绍如何整合Swagger以实现API文档化。以下是具体的步骤:
- 添加依赖
在项目的pom.xml文件中添加Springdoc和Swagger的相关依赖。以下是依赖的示例:<dependencies><!-- Springdoc dependencies --><dependency><groupId>org.springdoc</groupId><artifactId>springdoc-openapi-ui</artifactId><version>1.4.3</version></dependency><dependency><groupId>org.springdoc</groupId><artifactId>springdoc-openapi-data-rest</artifactId><version>1.4.3</version></dependency><!-- Other dependencies --></dependencies>
- 配置OpenAPI/Swagger
在项目的配置文件(例如application.yml或application.properties)中添加OpenAPI/Swagger的相关配置。以下是一个示例配置:
```yaml
springdoc:
openapi:
info:
title: Your API Title
version: 1.0.0
servers:
- url: http://localhost:8080
```
- 启用自动配置
在项目的启动类上添加@EnableSwaggerUi注解以启用Swagger UI。如果您的项目使用了Spring Security,还需要添加@EnableSwaggerSecurity注解。以下是一个示例:import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.context.annotation.Bean;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.service.ApiInfo;import springfox.documentation.service.Contact;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;import springfox.swagger2.ui.SwaggerUiConfig;import springfox.swagger2.ui.themes.*;import springfox.swagger2.ui.*;

发表评论
登录后可评论,请前往 登录 或 注册