深圳Java学习：Swagger

深圳Java学习：Swagger

1.swagger介绍

现在开发，很多采用前后端分离的模式，前端只负责调用接口，进行渲染，前端和后端的唯一联系，变成了API接口。因此，API文档变得越来越重要。swagger是一个方便我们更好的编写API文档的框架，而且swagger可以模拟http请求调用。

大部分采取的方式：Vue + SpringBoot，Vue通过js渲染页面，后端把数据传递给js，早期前端只负责写页面，然后把写好的HTML页面给后端，后端使用模板引擎（Jsp，Thymeleaf、 freemarker）进行开发。

前后端分离的好处：各自开发，相对独立，松耦合，前后端通过API进行交互，后端提供接口给前端，前端去调用该接口，但可能会导致前后端团队人员不能做到及时协商，出现一些问题。解决方式：早期使用实时更新文档，但非常繁琐，后来又使用postman来进行一些测试。

swagger是目前最流行的Api框架，官网：https://swagger.io/

2.springboot中集成swagger使用步骤：

导入依赖

io.springfox

<artifactId>springfox-swagger-ui</artifactId>

<version>2.9.2</version>

io.springfox

<artifactId>springfox-swagger2</artifactId>

<version>2.9.2</version>

创建配置类
@Configuration
@EnableSwagger2//开启Swagger2
public class SwaggerConfig {

}

然后启动测试运行，访问：http://localhost:8080/swagger-ui.html，看到如下页面：

手动配置实例，修改SwaggerConfig配置类
package com.qf.swagger.config;