Springboot整合Swagger

Eternal_space

已于 2023-09-15 10:13:49 修改

阅读量317

点赞数

于 2023-09-15 10:13:19 首次发布

本文链接：https://blog.youkuaiyun.com/Eternal_space/article/details/132895851

版权

本文档介绍了如何在SpringBoot项目中整合Swagger，通过添加依赖、配置Swagger类和添加接口注解，来生成和测试API接口文档。完成配置后，可以在浏览器中访问Swagger UI查看接口文档。

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

Swagger 官网：API Documentation & Design Tools for Teams | Swagger

1.添加依赖

在 pom.xml 文件中添加 Swagger 的 starter相关依赖

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

springfox-boot-starter 是针对 Spring Boot 项目提供的一个 starter，简化了 Swagger 依赖的导入，否则就需要在 pom.xml 文件中添加 springfox-swagger、springfox-swagger-ui 等多个相关依赖了。

2.添加Swagger配置类

@Configuration
@EnableOpenApi
public class SwaggerConfig {
    @Bean
    public Docket docket() {
        Docket docket = new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo()).enable(true)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.ceshi.controller"))             
                //swagger注册接口的包地址
                .paths(PathSelectors.any())
                .build();

        return docket;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("xx项目")  
                //标题
                .description("xx后端api文档")   
                //描述
                .contact(new Contact("张三", "111111","1234562163.com"))  
                //名称，url，邮箱
                .version("1.0")
                //版本号
                .build();
    }
}

（1）@Configuration 注解通常用来声明一个 Java 类为配置类（

（2）@EnableOpenApi 注解表明开启 Swagger服务。

（3）SwaggerConfig 类中包含一个 @Bean 注解声明的方法 docket()，该方法会被 Spring 的 AnnotationConfigApplicationContext 或 AnnotationConfigWebApplicationContext 类进行扫描，然后添加到 Spring 容器当中，

3.添加接口类进行测试

注: 添加的接口要包含在配置类中定义的包下面

@Api(tags = "测试 Swagger")
@RestController
@RequestMapping("/ceshi")
public class SwaggerController {

    @ApiOperation("测试swagger功能")
    @RequestMapping("/ceshi")
    public String test() {
        return "测试swagger功能";
    }
}

(1）@Api注解，标注在类上，该注解将该类标注为一个 Swagger 资源

(2) @ApiOperation 注解，用在方法上，描述这个方法的具体作用