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

项目现状：由于前后端分离，没有很好的前后端合作工具。

由于接口众多，并且细节复杂（需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等），高质量地创建这份文档本身就是件非常吃力的事，下游的抱怨声不绝于耳。

随着时间推移，不断修改接口实现的时候都必须同步修改接口文档，而文档与代码又处于两个不同的媒介，除非有严格的管理机制，不然很容易导致不一致现象。

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

添加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的配置类Swagger2。

@Configuration

@EnableSwagger2

public class Swagger2 {

@Bean

public Docket createRestApi() {

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

.select() .apis(RequestHandlerSelectors.basePackage("com.bai.controller

"))

.paths(PathSelectors.any())

.build();

}

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title("Spring Boot中使用Swagger2构建RESTful APIs")

.description("更多Spring Boot相关文章请关注：swagger官网")

.termsOfServiceUrl("https://swagger.io/")

.contact("程序猿DD")

.version("1.0")

.build();

}

如上代码所示，通过@Configuration注解，让Spring来加载该类配置。再通过@EnableSwagger2注解来启用Swagger2。

测试代码：

package com.bai.controller;

import com.bai.domain.User;

import io.swagger.annotations.ApiImplicitParam;

import io.swagger.annotations.ApiImplicitParams;

import io.swagger.annotations.ApiOperation;

import org.springframework.web.bind.annotation.*;

import java.util.*;

/**

 * Created by DELL on 2017/7/5.

 */

@RestController

@RequestMapping(value = "/users")     // 通过这里配置使下面的映射都在/users下，可去除

public class UsersController {

    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> r = new ArrayList<User>(users.values());

        return r;

    }

    @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.getId(), user);

        return "success";

    }

    @ApiOperation(value = "获取用户详细信息", notes = "根据url的id来获取用户详细信息")

    @ApiImplicitParam(name = "id", value = "用户ID", required = true, paramType = "path", dataType = "Long")

    @RequestMapping(value = "/{id}", method = RequestMethod.GET)

    public User getUser(@PathVariable Long id) {

        return users.get(id);

    }

    @ApiOperation(value = "更新用户详细信息", notes = "根据url的id来指定更新对象，并根据传过来的user信息来更新用户详细信息")

    @ApiImplicitParams({

            @ApiImplicitParam(name = "id", value = "用户ID", required = true, paramType = "path", dataType = "Long"),

            @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")

    })

    @RequestMapping(value = "/{id}", method = RequestMethod.PUT)

    public String putUser(@PathVariable Long id, @RequestBody User user) {

        User u = users.get(id);

        u.setUserName(user.getUserName());

        u.setEmail(user.getEmail());

        users.put(id, u);

        return "success";

    }

    @ApiOperation(value = "删除用户", notes = "根据url的id来指定删除对象")

    @ApiImplicitParam(name = "id", value = "用户ID", required = true,paramType="path", dataType = "Long")

    @RequestMapping(value = "/{id}", method = RequestMethod.DELETE)

    public String deleteUser(@PathVariable Long id) {

        users.remove(id);

        return "success";

    }

}

完成上述代码添加上，启动Spring Boot程序，访问：http://localhost:8080/swagger-ui.html
。就能看到前文所展示的RESTful API的页面。