什么是Swagger？

Swagger是一个用于快速生成开发文档的工具，它能够跟着代码的变更而同步更新开发文档。

为什么需要Swagger？

在开发中需求是会经常变化的，需求快速的变更使得我们不得不同步更新相应的各种文档，而这无形之中增加了日常的工作量，而Swagger呢能够自动生成开发文档，并且会自动更新相关文档信息！

开始使用Swagger

1. 导入Swagger相关依赖

  <!--swagger2所需依赖-->
  <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.9.2</version>
  </dependency>

  <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.9.2</version>
  </dependency>

2. 在SpringBoot主类Main中添加@EnableSwagger2注解

@EnableAsync
@EnableDiscoveryClient
@SpringBootApplication
@EnableSwagger2 //引入Swagger
public class HouseServiceApplication {
  //---------业务代码
}

3. 启动项目，访问/swagger-ui.html路径

4. 选择自己需要的api文档集

可以看到里边包含了我们在处理器里边定义的所有接口，并且有接口的详细信息（所需请求参数、大致返回结果、相关状态码、可支持的访问方法）