SpringBoot v2.6.13 整合 swagger

程序员-珍2024-09-20 14:06

在Spring Boot 2.6.13中整合Swagger需要以下步骤：

添加Swagger依赖到pom.xml：

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配置类：

java 复制代码

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

在application.properties或application.yml中配置Swagger：

application.properties

springfox.documentation.enabled=true

或者

application.yml

springfox:
  documentation:
    enabled: true

启动Spring Boot应用，并访问 http://:/swagger-ui.html 查看Swagger文档。

确保Spring Boot版本与Swagger版本兼容。如果使用的Spring Boot版本是2.6.13，那么可以使用与Spring Boot 2.6兼容的Swagger版本，例如2.9.2。如果Spring Boot升级到了新版本，可能需要更新Swagger依赖到对应的新版本。