Spring Boot整合Swagger2

Spring Boot：整合Swagger2文档

前言
在实际开发过程中，我们编写的接口不仅提供给开发测试进行相关的白盒测试，还要给其他组员对接接口。那么势必存在如何在多人协作中共享和及时更新API开发接口文档的问题。

假如你已经对传统的wiki文档共享方式所带来的弊端深恶痛绝，那么尝试一下Swagger2 方式，一定会让你有不一样的开发体验。

使用 Swagger2 集成文档具有以下几个优势：

（1）、功能丰富 ：支持多种注解，自动生成接口文档界面，支持在界面测试API接口功能；
（2）、及时更新 ：开发过程中花一点写注释的时间，就可以及时的更新API文档，省心省力；
（3）、整合简单 ：通过添加pom依赖和简单配置，内嵌于应用中就可同时发布API接口文档界面，不需要部署独立服务。

那么我们就通过Spring Boot 来整合Swagger实现在线API文档的功能。

1、首先，我们需要创建SpringBoot项目并在pom文件中添加依赖

2、然后，我们需要添加配置类


3、其次，我们需要添加控制器HelloController.java

4、最后，我们启动我们的项目，并访问http://localhost:8080/swagger-ui.html，进入swagger接口文档界面。

5、我们也可以在这里测试我们的程序

常用注解说明
swagger2 通过注解接口生成文档，包括接口名，请求方法，参数，返回信息等。

@Api: 修饰整个类，用于controller类上

@ApiOperation: 描述一个接口，用户controller方法上

@ApiParam: 单个参数描述

@ApiModel: 用来对象接收参数,即返回对象

@ApiModelProperty: 对象接收参数时，描述对象的字段

@ApiResponse: Http响应其中的描述，在ApiResonse中

@ApiResponses: Http响应所有的描述，用在

@ApiIgnore: 忽略这个API

@ApiError: 发生错误的返回信息

@ApiImplicitParam: 一个请求参数

@ApiImplicitParam: 多个请求参数