logo

Springboot3.0整合Swagger:从Springfox到Springdoc的迁移指南

作者:很酷cat2024.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文档化。以下是具体的步骤:

  1. 添加依赖
    在项目的pom.xml文件中添加Springdoc和Swagger的相关依赖。以下是依赖的示例:
    1. <dependencies>
    2. <!-- Springdoc dependencies -->
    3. <dependency>
    4. <groupId>org.springdoc</groupId>
    5. <artifactId>springdoc-openapi-ui</artifactId>
    6. <version>1.4.3</version>
    7. </dependency>
    8. <dependency>
    9. <groupId>org.springdoc</groupId>
    10. <artifactId>springdoc-openapi-data-rest</artifactId>
    11. <version>1.4.3</version>
    12. </dependency>
    13. <!-- Other dependencies -->
    14. </dependencies>
  2. 配置OpenAPI/Swagger
    在项目的配置文件(例如application.ymlapplication.properties)中添加OpenAPI/Swagger的相关配置。以下是一个示例配置:
    ```yaml
    springdoc:
    openapi:
    info:
    title: Your API Title
    version: 1.0.0
    servers:
  1. 启用自动配置
    在项目的启动类上添加@EnableSwaggerUi注解以启用Swagger UI。如果您的项目使用了Spring Security,还需要添加@EnableSwaggerSecurity注解。以下是一个示例:
    1. import org.springframework.boot.SpringApplication;
    2. import org.springframework.boot.autoconfigure.SpringBootApplication;
    3. import org.springframework.context.annotation.Bean;
    4. import springfox.documentation.builders.PathSelectors;
    5. import springfox.documentation.builders.RequestHandlerSelectors;
    6. import springfox.documentation.service.ApiInfo;
    7. import springfox.documentation.service.Contact;
    8. import springfox.documentation.spi.DocumentationType;
    9. import springfox.documentation.spring.web.plugins.Docket;
    10. import springfox.documentation.swagger2.annotations.EnableSwagger2;
    11. import springfox.swagger2.ui.SwaggerUiConfig;
    12. import springfox.swagger2.ui.themes.*;
    13. import springfox.swagger2.ui.*;

相关文章推荐

发表评论