springboot中使用swagger2构建强大的RESTful API文档
目录
一 、什么是swagger？（简介、使用它带来的便捷）
二 、 如何搭建swagger
三、搭建完成后如何使用swager
一 、什么是swagger？（简介、使用它带来的便捷）
Swagger 是一个RESTful接口的文档的实时生成与测试工具。没接触过类似工具的你可能对这句话没什么概念，不要急，我来慢慢解释。
使用REST的原因之一就是方便前后端分离开发，后端开发者写后端的逻辑，前端开发者写前端的逻辑，然后大家约定好一个API的风格，使用HTTP的get、post、put、delete来对应资源的CURD。避免了这种情况的发生：前端开发者拿着后端提供的厚厚的API文档边查阅边愤愤地开发，每个业务逻辑对应一个接口规范，混乱不堪。然后某一天后端改了逻辑，删掉了几个接口又增加了几个接口，前端又要大范围地改代码，然后前后端就打起来了。
为了避免打架，规范了API的设计，使用了较为轻便的RESTful风格。而Swagger起到一个锦上添花的作用，它使得前后端的协同变得更加效率。后端开发者在定义好接口后，Swagger会自动生成并更新文档，文档中会详细记录接口的使用方法，需要传入哪些参数，又会返回什么样的结果，即节约了写文档的时间，又提高了文档的同步速度，提高了开发效率。另外Swagger不止这些功能，它还有一个强大的功能，就是在文档中直接对接口进行测试，我们可以使用Swagger模拟用户的真实操作，向后台发一个请求来验证接口是否满足需求。说了这么多，可能你还是不太明白，下面这个链接就是就是Swagger生成的文档：http://petstore.swagger.io/?_ga=2.151670393.1145939008.1514200525-1067691787.1514200525
这是官方提供一个demo文档，可以简单操作一下，聪明的你应该豁然开朗了吧！
二 、 如何搭建swagger
添加Swagger2依赖
在pom.xml中加入Swagger2的依赖
io.springfox
springfox-swagger2
2.2.2
io.springfox
springfox-swagger-ui
2.2.2
创建代码配置类
在 config中创建SwaggerConfig.java
package com.rails.wifi.cmsservicenew.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.rails.****.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("**服务")
.description("**服务 [Restful Api]")
.contact(new Contact("****公司","http://www.****.cn","****@rails.cn"))
.version("1.0.0")
.build();
}
}
如上代码所示，通过@Configuration注解，让Spring来加载该类配置。再通过@EnableSwagger2注解来启用Swagger2。
再通过createRestApi函数创建Docket的Bean之后，apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中）。select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现，本例采用指定扫描的包路径（"com.rails.****.controller"）来定义，Swagger会扫描该包下所有Controller定义的API，并产生文档内容（除了被@ApiIgnore指定的请求）。
添加文档内容
在完成了上述配置后，其实已经可以生产文档内容，但是这样的文档主要针对请求本身，而描述主要来源于函数等命名产生，对用户并不友好，我们通常需要自己增加一些说明来丰富文档内容。如下所示，我们通过@ApiOperation注解来给API增加说明、通过@ApiImplicitParams、@ApiImplicitParam注解来给参数增加说明。
@RequestMapping("/roleApi/v1")
public interface RoleApiV1 {
/**
* 新增角色
* @param role
* @return
* @throws Exception
*/
@RequestMapping(value="addRole",method = RequestMethod.POST)
ResultBean addRole(@RequestBody RoleDTO roleDTO) throws Exception;
/**
* 根据主键查找角色
* @param id
* @return
* @throws Exception
*/
@RequestMapping(value="findById",method = RequestMethod.GET)
ResultBean findById(@RequestParam(name="id") long id) throws Exception;
/**
* 删除角色
* @param id
* @return
* @throws Exception
*/
@RequestMapping(value="delete",method = RequestMethod.DELETE)
ResultBean delete(@RequestParam(name="id") long id) throws Exception;
/**
* 更新角色
* @param role
* @return
* @throws Exception
*/
@RequestMapping(value="updateRole",method = RequestMethod.PUT)
ResultBean updateRole(@RequestBody RoleDTO roleDTO) throws Exception;
}三、搭建完成后如何使用swager
完成上述代码添加上，启动Spring Boot程序，访问：http://localhost:8080/swagger-ui.html
。就能看到前文所展示的RESTful API的页面,下图:
我们可以再点开具体的API请求，以POST类型的/users请求为例，可找到上述代码中我们配置的Notes信息以及参数user的描述信息，如下图所示。
API文档访问与调试
在上图请求的页面中，我们看到user的Value是个输入框？是的，Swagger除了查看接口功能外，还提供了调试测试功能，我们可以点击上图中右侧的Model Schema（黄色区域：它指明了User的数据结构），此时Value中就有了user对象的模板，我们只需要稍适修改，点击下方“Try it out！”按钮，即可完成了一次请求调用！
此时，你也可以通过几个GET请求来验证之前的POST请求是否正确。
相比为这些接口编写文档的工作，我们增加的配置内容是非常少而且精简的，对于原有代码的侵入也在忍受范围之内。因此，在构建RESTful API的同时，加入swagger来对API文档进行管理，是个不错的选择。