在的网站大多都是前后端分离式的开发,前后端都衍生出了自己的框架。现在前后端交互的唯一方式就是 API 接口。
曾经前后端交互都需要后端人员手动编写 API 接口文档,规定路径、请求方式、返回类型,这样效率很低。
swagger 就是更好地书写 API 文档的框架。
二、swagger 介绍
swagger 可以根据后台接口自动生成可视化的 restful 风格的 API 文档,并可以进行 API 测试(发送各种请求,测试接口)
1、前端人员不用再去理解后端代码,后端人员也不用专门编写接口文档。2、swagger 直接自动生成可供测试、可视化的 API 文档,前端人员在不知道后端代码的情况下,也能根据 swagger 提供的 API 文档理解每个接口的作用,并可以测试接口是否能够正常使用。
三、在 maven+springboot 项目中使用 swagger
1.首先在 pom.xml 中导入依赖
springfox-swagger2 是 swagger 的 java 实现 springfox-swagger-ui 是网页上显示 swagger 文档的 jar 包
<!--swagger jar包-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.8.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.8.0</version>
</dependency>
<!--swagger jar包-->
复制代码
复制代码
2.编写 swagger 配置文件
创建一个 config 文件夹,在文件夹里创建 SwaggerConfig.java 文件作为我们的 swagger 配置文件。
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import spr