Spring Boot中使用Swagger2构建强大的RESTful API文档

下面的内容我们会以上篇中（ 用Spring Boot搭建简单web项目 ）搭建的工程进行下面的操作。

一，添加Swagger2依赖

在pom.xml中加入Swagger2依赖

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

二，创建 Swagger2配置类

在application.java同级的包路径下创建Swagger2的配置类

package com.lee;
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.lee.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot中使用Swagger2构建RESTful APIs")
.description("更多文章请关注：https://my.oschina.net/leeyo")
.termsOfServiceUrl("https://my.oschina.net/leeyo")
.contact("抓啊抓啊抓")
.version("1.0")
.build();
}
}

如上代码所示，通过

@Configuration

注解，让Spring来加载该类配置。再通过

@EnableSwagger2

注解来启用Swagger2。
再通过

createRestApi

函数创建

Docket

的Bean之后，

apiInfo()

用来创建该Api的基本信息（这些基本信息会展现在文档页面中）。

select()

函数返回一个

ApiSelectorBuilder

实例用来控制哪些接口暴露给Swagger来展现，本例采用指定扫描的包路径来定义，Swagger会扫描该包下所有Controller定义的API，并产生文档内容（除了被

@ApiIgnore

指定的请求）。

三，添加文档内容

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

@ApiOperation

注解来给API增加说明、通过

@ApiImplicitParams

、

@ApiImplicitParam

注解来给参数增加说明。

package com.lee.controller;

import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.lee.pojo.User;

@RestController
@RequestMapping("/user")
public class UserController {

static Map<Long,User> users = Collections.synchronizedMap(new HashMap<Long,User>());

@ApiOperation(value="获取用户列表", notes="")
@RequestMapping(value={""},method = RequestMethod.GET)
public List<User> getUserList(){
List<User> list = new ArrayList<User>(users.values());
return list;
}

@ApiOperation(value="创建用户", notes="根据User对象创建用户")
@ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
@RequestMapping(value="", method=RequestMethod.POST)
public String postUser(@RequestBody User user){
users.put(user.getUserId(), user);
return "success";
}

@ApiOperation(value="获取用户详细信息", notes="根据url的id来获取用户详细信息")
@ApiImplicitParam(name = "userId", value = "用户ID", required = true, dataType = "Long",paramType="path")
@RequestMapping(value="/{userId}", method=RequestMethod.GET)
public User getUser(@PathVariable Long userId) {
return users.get(userId);
}

@ApiOperation(value="更新用户详细信息", notes="根据url的id来指定更新对象，并根据传过来的user信息来更新用户详细信息")
@ApiImplicitParams({
@ApiImplicitParam(name = "userId", value = "用户ID", required = true, dataType = "Long",paramType="path"),
@ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
})
@RequestMapping(value="/{userId}", method=RequestMethod.PUT)
public String putUser(@PathVariable Long userId, @RequestBody User user) {
User u = users.get(userId);
u.setUserName(user.getUserName());
u.setAddress(user.getAddress());
users.put(userId, u);
return "success";
}

@ApiOperation(value="删除用户", notes="根据url的id来指定删除对象")
@ApiImplicitParam(name = "userId", value = "用户ID", required = true, dataType = "Long",paramType="path")
@RequestMapping(value="/{userId}", method=RequestMethod.DELETE)
public String deleteUser(@PathVariable Long userId) {
users.remove(userId);
return "success";
}
}

完成上述代码添加上，启动Spring Boot程序，访问：http://localhost:8080/swagger-ui.html
。就能看到前文所展示的RESTful API的页面。我们可以再点开具体的API请求，以POST类型的/users请求为例，可找到上述代码中我们配置的Notes信息以及参数user的描述信息，如下图所示。

demo下载

http://git.oschina.net/leeyo/spring-boot