Spring Boot 集成 Swagger

原创已于 2022-03-31 18:37:40 修改 · 985 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#java

于 2022-03-31 18:23:37 首次发布

SpringBoot 专栏收录该内容

2 篇文章

订阅专栏

本文介绍了如何在SpringBoot项目中集成Swagger，从创建项目、添加依赖、配置Swagger到编写测试Controller，详细展示了每个步骤。在配置过程中遇到SpringBoot 2.6.5版本与Swagger 2.9.2版本不兼容的问题，通过降级SpringBoot版本为2.5.6得以解决。

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

Spring Boot 集成 Swagger

1.初始化一个Spring Boot 项目信息

使用spring官方自带初始化的地址初始化
地址：https://start.spring.io/
在这里插入图片描述
引入web包

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
</dependency>

2.在初始化完成的SpringBoot项目中引入Swagger的依赖包

<properties>
    <java.version>1.8</java.version>
    <swagger.version>2.9.2</swagger.version>
</properties>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>${swagger.version}</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>${swagger.version}</version>
</dependency>

3.添加Swagger配置类


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class SwaggerConfig {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                .select()
                // api的包路径
                .apis(RequestHandlerSelectors.basePackage("com.tms.spring.boot.swagger.controller"))
                .paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                // 文档标题
                .title("Kitty API Doc")
                // 文档描述
                .description("restful 风格接口")
                // 版本号
                .version("1.0")
                .build();
    }
}

4.添加测试Controller

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;

import java.util.Map;

/**
 * swagger接口文档测试类
 */
 // 类描述
@Api(tags = "swagger接口文档测试类")
@RestController
@RequestMapping("/demo/swagger/url")
public class DemoSwaggerController {
	
	//  方法描述
    @ApiOperation(value = "GET请求测试接口", notes = "GET请求测试接口")
    // 方法参数描述
    @ApiImplicitParam(name = "param", value = "请求参数", required = true, dataType = "string")
    @GetMapping("/getMapping")
    public String getMapping (@RequestParam("param") String param) {
        return "this is swagger project getMapping param:" + param;
    }

    @ApiOperation(value = "POST请求测试接口", notes = "POST请求测试接口")
    // 多个参数描述
    @ApiImplicitParams({
            @ApiImplicitParam(name = "value1", value = "值1", required = true, dataType = "string"),
            @ApiImplicitParam(name = "value2", value = "值2", required = true, dataType = "string"),
    })
    @PostMapping("/postMapping")
    public String postMapping (@RequestBody Map paramMap) {
        return "this is swagger project postMapping paramMap:" + paramMap;
    }

}

5.修改启动类，添加启动Swagger

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2
public class SpringBootSwaggerApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringBootSwaggerApplication.class, args);
    }

}