springboot 集成swagger 步骤

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.

目录

概述

需求：

设计思路

实现思路分析

1.基础平台搭建

使用如下脚手架，创建基础环境，https://start.aliyun.com/bootstrap.html

2.步骤

要将Swagger集成到Spring Boot项目中，可以按照以下步骤进行操作：

1. 添加Swagger依赖：在项目的Maven或Gradle配置文件中，添加Swagger依赖。

• Maven:

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

或者

  <!-- 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'

2. 创建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 {
}

3. 配置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
                }
            });
    }

    // ...

}

4. 运行项目并访问Swagger UI：启动Spring Boot项目后，可以通过访问Swagger UI的路径查看API文档。

默认访问路径是：http://localhost:8080/swagger-ui/index.html。

访问url: http://localhost:9090/myapp/swagger-ui.html#/

以上就是将Swagger集成到Spring Boot项目的基本步骤。根据实际需要，还可以进行更多的配置，例如配置API文档的标题、描述、版本等信息。

参考资料和推荐阅读

参考资料
官方文档
开源社区
博客文章
书籍推荐

1. https://blog.csdn.net/pleaseprintf/article/details/129945587

欢迎阅读，各位老铁，如果对你有帮助，点个赞加个关注呗！同时，期望各位大佬的批评指正~，如果有兴趣，可以加文末的交流群，大家一起进步哈