SpringBoot整合Swagger2

最新推荐文章于 2023-05-18 21:12:25 发布

boss朴

最新推荐文章于 2023-05-18 21:12:25 发布

阅读量326

点赞数

分类专栏：框架 Swagger 文章标签： spring boot swagger2

本文链接：https://blog.csdn.net/m0_46159545/article/details/107179995

版权

本文介绍了如何在SpringBoot项目中整合Swagger2，包括Swagger的基本介绍、引入依赖、配置Swagger2、自定义文档信息、设置API扫描范围、环境控制Swagger开启、API分组设置以及API文档注释的方法，帮助开发者生成清晰的API文档并支持接口测试。

摘要由CSDN通过智能技术生成

SpringBoot整合Swagger2

一、Swagger简介

Swagger是一款RESTFUL接口的文档在线自动生成+功能测试功能软件，被广泛应用于前后端分离项目中，用来降低前后端开发人员的沟通成本，因为Swagger可以根据后端接口的设计动态的生成restful风格的API文档供前端开发人员的使用。除此之外，Swagger还提供了接口测试功能，使得开发人员可以方便的测试接口的可用性。有了Swagger以后，开发人员再也不用维护接口文档了。

Swagger目前应用最多的版本就是Swagger2，下面说明SpringBoot如何整合Swagger2

二、SpringBoot整合Swagger2

1、在项目中引入下面两个jar包

		<!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

2、创建一个Swagger的配置类

并使用@EnableSwagger2注解开启Swagger2的支持

//表明是一个配置类
@Configuration
//开启Swagger2的支持
@EnableSwagger2
public class SwaggerConfig {
   
}

此时就可以在项目中利用默认配置使用Swagger了，启动项目后，访问 http://localhost:8080/swagger-ui.html/ 即可得到一份在线API文档，如下：
在这里插入图片描述
此时文档中的信息都是默认值，一般情况下我们需要修改其中的信息，如下。

3、自定义Swagger文档信息

向容器中加入一个Docket bean，替换掉默认使用的Docket，它是Swagger的核心bean，可以帮助我们自定义文档中的信息。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration