springboot整合Swagger在线文档

r囧r小猫 2024-03-31 17:19 116阅读 0赞

## SpringBoot整合Swagger2在线文档 ##

### 一 什么是swagger？ ###

我们前面有讲到说开发时会创建Restful风格的API接口，供第三方或前端人员使用，那么前端人员在使用的过程中怎么知道有哪些接口呢。这个时候可以通过写接口文档来解决，但不同的程序员写出来的可能不一样，前端经常抱怨后端给的接口文档与实际情况不一致。后端又觉得编写及维护接口文档会耗费不少精力，经常来不及更新。无论是前端调用后端，还是后端调用后端，都期望有一个好的接口文档。如果能有工具帮我们能规范接口文档，最好能自动帮我们生成接口文档就好了。于是生成在线文档的工具就是 swagger就产生了。

#### 1、什么是Swagger ？ ####

Swagger是一款开源工具，依据OpenAPI规范（OpenAPI Specification，简称OAS）可以帮助你设计，构建，生成文档，调用REST APIs。

#### 2、Swagger优点 ####

1.号称世界上最流行的Api框架；
    
    2.RestFul Api 文档在线自动生成工具，Api文档与Api定义同步更新（写完代码文档就实时更新）
    
    3.可以直接运行，可以在线测试Api接口；
    
    4.支持多种语言（java，php等）

### 二 Springboot中怎么整合Swagger2 ###

Swagger工具既然这么好用，那么我们就来看一下在SpringBoot中怎么整合Swagger。

Swagger的工具很多，但SpringBoot中整合Swagger主要是使用Swagger来构建强大的Restful文档。也就是里面的Swagger UI工具。

这里我们用的版本是Swagger2。

#### 1.创建Springboot项目 ####

选择web、 lombok、 mysql、spring data jpa 依赖 （也可以将spring data jpa 换成mybatis相关依赖）

项目创建成功后在pom文件中添加druid依赖包

完成后pom文件如下：

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            
            <version>5.1.45</version>
            <scope>runtime</scope>
        </dependency>
    
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.10</version>
        </dependency>  
    
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>