title: 构建微服务：Spring Boot中使用Swagger2构建RESTful API文档

为了减少与其他团队平时开发期间的频繁沟通成本，传统做法我们会创建一份RESTful API文档来记录所有接口细节，然而这样的做法有以下几个问题：

接口众多，并且细节复杂,维护成本偏高

当不断修改接口实现的时候都必须同步修改接口文档，否则容易照成文档不一致.

为了解决上面这样的问题，本文将介绍RESTful API的重磅好伙伴Swagger2，它可以轻松的整合到Spring Boot中,并与Spring MVC程序配合组织出强大RESTful API文档。它既可以减少我们创建文档的工作量，同时说明内容又整合入实现代码中，让维护文档和修改代码整合为一体,可以让我们在修改代码逻辑的同时方便的修改文档说明。
另外Swagger2也提供了强大的页面测试功能来调试每个RESTful API。具体效果如下图所示：
swagger.png

1. 添加Swagger2依赖

在pom.xml中加入Swagger2的依赖

<springfox.version>2.2.2</springfox.version>

<!-- Swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>${springfox.version}</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>${springfox.version}</version>
</dependency>

1. 创建Swagger2配置类

@Configuration
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.alanzh.portal.action"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("WishPlatform构建RESTful APIs")
                .description("使用SpringBoot构建WishPlatform")
                .termsOfServiceUrl("http://www.alanzh.com/")
                .contact("ALanZh")
                .version("1.0")
                .build();
    }
}

@Configuration注解，让Spring来加载该类配置.
@EnableSwagger2注解来启用Swagger2。

再通过createRestApi函数创建Docket的Bean之后，apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中）。select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现，本例采用指定扫描的包路径来定义，Swagger会扫描该包下所有Controller定义的API，并产生文档内容（除了被@ApiIgnore指定的请求）。

3.添加文档内容

在完成了上述配置后，其实已经可以生产文档内容，但是这样的文档主要针对请求本身，而描述主要来源于函数等命名产生，对用户并不友好，我们通常需要自己增加一些说明来丰富文档内容。如下所示，我们通过

@ApiOperation注解来给API增加说明、
@ApiImplicitParams、@ApiImplicitParam注解来给参数增加说明。

@RestController
@RequestMapping(value="/wish")
public class WishEntryAction {

    @ApiOperation(value="get WishEntry List", notes="")
    @RequestMapping(value="/", method=RequestMethod.POST) 
    public String addWishEntry(@ModelAttribute WishEntry wishEntry) {
        return "sucess";
    }

    @ApiOperation(value="delete WishEntry", notes="delete WishEntry accroding ID")
    @ApiImplicitParam(name = "wishEntryId", value = "wishEntryId", required = true, dataType = "Long")
    @RequestMapping(value="/{wishEntryId}", method=RequestMethod.DELETE) 
    public String deleteWishEntry(@PathVariable Long wishEntryId) {
        return "sucess";
    }

    @RequestMapping(value="/", method=RequestMethod.GET)
    public String getWishEntries() {
        return "sucess";
    }

    @ApiOperation(value="get WishEntry", notes="get WishEntry accroding ID")
    @ApiImplicitParam(name = "wishEntryId", value = "wishEntryId", required = true, dataType = "Long")
    @RequestMapping(value="/{wishEntryId}", method=RequestMethod.GET) 
    public String getWishEntry(@PathVariable Long wishEntryId) {
        return "sucess";
    }

    @ApiOperation(value="update WishEntry", notes="update WishEntry accroding ID")
    @ApiImplicitParam(name = "wishEntryId", value = "wishEntryId", required = true, dataType = "Long")
    @RequestMapping(value="/{wishEntryId}", method=RequestMethod.PUT) 
    public String updateWishEntry(@PathVariable Long wishEntryId) {
        return "sucess";
    }

}

完成上述代码添加上，启动Spring Boot程序，访问：http://localhost:8080/swagger-ui.html
。就能看到前文所展示的RESTful API的页面。我们可以再点开具体的API请求，如下图所示。
swagger.png
相比为这些接口编写文档的工作，我们增加的配置内容是非常少而且精简的，对于原有代码的侵入也在忍受范围之内。因此，在构建RESTful API的同时，加入swagger来对API文档进行管理，是个不错的选择。

参考信息
http://swagger.io/
http://blog.didispace.com/springbootswagger2/