springboot 集成swagger 步骤

迅捷的软件产品制作专家

已于 2024-01-26 21:38:19 修改

阅读量1.1k

点赞数 22

CC 4.0 BY-SA版权

分类专栏： spring boot 文章标签： spring boot 后端 java

于 2024-01-26 21:38:12 首次发布

本文链接：https://blog.youkuaiyun.com/xiamaocheng/article/details/135875179

spring boot 专栏收录该内容

74 篇文章

订阅专栏

本文详细介绍了如何在SpringBoot项目中集成Swagger，包括添加依赖、创建配置类、设置访问路径以及参考资源。步骤涉及基础平台搭建、添加Swagger依赖、配置SwaggerUI路径和运行项目测试。

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

Survive by day and develop by night.
talk for import biz , show your perfect code,full busy，skip hardness,make a better result,wait for change,challenge Survive.
happy for hardess to solve denpendies.

  <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>


        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

Gradle:

implementation 'io.springfox:springfox-boot-starter:3.0.0'

创建Swagger配置类：在项目的src/main/java目录下创建一个Swagger配置类，该类使用Swagger注解进行配置。

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.example.myproject.controllers"))
            .paths(PathSelectors.any())
            .build()
            .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            .title("My Project API")
            .description("API documentation for My Project")
            .version("1.0.0")
            .build();
    }

}

2.9.2版本对应的是：

import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;


import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;



import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {
}

配置Swagger UI访问路径（可选）：默认情况下，Swagger UI可以通过/swagger-ui/index.html路径访问，可以根据需要修改访问路径。

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Autowired
    private ServletContext servletContext;

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.example.myproject.controllers"))
            .paths(PathSelectors.any())
            .build()
            .apiInfo(apiInfo())
            .pathProvider(new RelativePathProvider(servletContext) {
                @Override
                public String getApplicationBasePath() {
                    return "/myproject"; // 修改访问路径为/myproject
                }
            });
    }

    // ...

}