Swagger，减少前后端工程师撕逼的神器

Swagger 是最流行的 API 开发工具，它遵循 OpenAPI Specification（OpenAPI 规范，也简称 OAS）。

在企业日常工作中已经成为了后端和前端人员必备的技能。后端人员要写好Swagger相关的配置,制作出合理易于阅读的Swagger接口文档，而前端人员要根据接口文档需要的数据格式提供给后端合理的数据，并且可能使用Swagger进行简单的接口测试，因此Swagger是非常重要的。本文就来一个Swagger的入门

什么是Swagger

前后端分离

• 前端 -> 前端控制层、视图层
• 后端 -> 后端控制层、服务层、数据访问层
• 前后端通过API进行交互
• 前后端相对独立且松耦合

产生的问题

• 前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发

简介

• Swagger 是最流行的 API 开发工具，它遵循 OpenAPI Specification（OpenAPI 规范，也简称 OAS）。
• Swagger 可以贯穿于整个 API 生态，如 API 的设计、编写 API 文档、测试和部署。
• Swagger 是一种通用的，和编程语言无关的 API 描述规范。

使用场景：

• 我们在使用Resultful API都开发完成了，就可以使用 Swagger-editor 来编写 API 文档（ yaml 文件 或 json 文件），然后通过 Swagger-ui 来渲染该文件，以非常美观的形式将你的 API 文档，展现给你的团队或者客户。

• 在前后端集成联调时，前端和后端就可以及时沟通，沟通需要传输的数据格式，并且可以及时同步。没有swagger之前，前后端的交流使用的是接口文档，但是接口文档的维护很难保证维护的及时性。可能前后端手中的接口文档不同，这就导致在接口联调时，就出现了问题。

怎么使用Swagger

使用SpringBoot集成Swagger

• 需要两个包
  1. Springfox-swagger2
  2. swagger-springmvc
• 注意：JDK的版本必须是JDK1.8之上，否则Swagger2无法运行

在SpringBoot中使用Swagger

1. 新建项目（创建一个SpringBoot项目即可）
   • 如果在创建SpringBoot项目时出现Artifact contains illegal characters，说明在创建时出现了非法字符。

2. 导入依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>

3. 编写HelloController，测试确保运行成功！(代码太简单了，就不列举了，只要能保证程序能够正常启动就OK😋)
4. 要使用Swagger，我们需要编写一个配置类-SwaggerConfig来配置 Swagger

package per.leiyu.swaggerdemo;

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration //配置类
@EnableSwagger2