Swagger2构建RESTful (一)

认识Swagger
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。

   我们的RESTful API就有可能要面对多个开发人员或多个开发团队：IOS开发、Android开发或是Web开发等。为了减少与其他团队平时开发期间的频繁沟通成本，传统做法我们会创建一份RESTful API文档来记录所有接口细节，然而这样的做法有以下几个问题：

由于接口众多，并且细节复杂（需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等），高质量地创建这份文档本身就是件非常吃力的事，下游的抱怨声不绝于耳。
随着时间推移，不断修改接口实现的时候都必须同步修改接口文档，而文档与代码又处于两个不同的媒介，除非有严格的管理机制，不然很容易导致不一致现象。
为了解决上面这样的问题，本文将介绍RESTful API的重磅好伙伴Swagger2，它可以轻松的整合到Spring Boot中，并与Spring MVC程序配合组织出强大RESTful API文档。它既可以减少我们创建文档的工作量，同时说明内容又整合入实现代码中，让维护文档和修改代码整合为一体，可以让我们在修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了强大的页面测试功能来调试每个RESTful API。具体效果如下图所示：
Swagger2构建RESTful (一)
下面来具体介绍，如果在Spring Boot中使用Swagger2。首先，我们需要一个Spring Boot实现的RESTful API工程

一、添加Swagger2依赖
在pom.xml中加入Swagger2的依赖

    <!-- 添加Swagger2依赖 -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.8.0</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.8.0</version>
    </dependency>

二、创建Swagger2配置类

/**
 * @author Ray
 * @date 2018/7/1 0001
 * Swagger2的配置文件，在项目的启动类的同级文件建立
 */
@Configuration //标记配置类
@EnableSwagger2 //开启在线接口文档
public class Swagger2 {
 
    /**
     * 再通过createRestApi函数创建Docket的Bean之后，
     * apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中）
     * select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现，
     * 本例采用指定扫描的包路径来定义，
     * Swagger会扫描该包下所有Controller定义的API，并产生文档内容（除了被@ApiIgnore指定的请求）。
     */
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //指向自己的controller即可
                .apis(RequestHandlerSelectors.basePackage("com.ray.chapter315.controller"))
                .paths(PathSelectors.any())
                .build();
    }
 
    /**
     * 设置文档信息
     */
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                //页面标题
                .title("SpringBoot中使用Swagger2构建RESTful API")
                //描述
                .description("更多资料, 请查看: https://blog.****.net/q343509740")
                //设置作者联系方式,可有可无
                .contact("Ray")
                //版本号
                .version("1.0")
                .build();
    }
}

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

三、Controller添加文档内容

/**
 * @author Ray
 * @date 2018/7/1 0001
 * 我们通过@ApiOperation注解来给API增加说明
 * 通过@ApiImplicitParams、@ApiImplicitParam注解来给参数增加说明
 */
@RestController
@RequestMapping(value = "/users") // 通过这里配置使下面的映射都在/users下，可去
public class UserController {
 
    static Map<Long, User> users = Collections.synchronizedMap(new HashMap<>());
 
    /**
     * 处理"/users/" 的GET请求,用来获取用户列表
     * 还可以通过@RequestParam从页面中传递参数来进行查询条件或者翻页信息的传递
     */
    @ApiOperation(value = "获取用户列表", notes = "获取所有用户列表")
    @RequestMapping(value = "/", method = RequestMethod.GET)
    public List<User> getUserList(){
        List<User> list = new ArrayList<>(users.values());
        return list;
    }
 
    /**
     * 处理"/users/" 的POST请求,用来创建User
     * 除了@ModelAttribute绑定参数之外,还可以通过@RequestParam从页面中传递参数
     */
    @ApiOperation(value = "创建用户", notes = "根据User对象创建用户")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用户编号(必填)", required = true, dataType = "Long"),
            @ApiImplicitParam(name = "name", value = "用户名称", dataType = "String"),
            @ApiImplicitParam(name = "age", value = "用户年龄", dataType = "Integer"),
            @ApiImplicitParam(name = "user", value = "用户实体User(不填: 默认值)", dataType = "User", defaultValue = "User"),
    })
    @RequestMapping(value = "/", method = RequestMethod.POST)
    public String postUser(@ModelAttribute User user){
        users.put(user.getId(), user);
        return "success";
    }
 
    /**
     * 处理"/users/{id}" 的GET请求,用来获取url中id值得User信息
     * url中的id可通过@PathVariable绑定到函数的参数中
     */
    @ApiOperation(value = "获取用户详细信息", notes = "根据url的id来获取用户详细信息")
    @ApiImplicitParam(name = "id", value = "用户编号(必填)", required = true, dataType = "Long", paramType = "path")
    @RequestMapping(value = "/{id}", method = RequestMethod.GET)
    public User getUser(@PathVariable Long id){
        return users.get(id);
    }
 
    /**
     * 处理"/users/{id}" 的PUT请求, 用来更新User信息
     */
    @ApiOperation(value = "更新用户详细信息", notes = "根据url的id来指定更新的对象,并根据传过来的user信息来更新用户详细信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用户编号(必填)", required = true, dataType = "Long", paramType = "path"),
            @ApiImplicitParam(name = "name", value = "用户名称", dataType = "String"),
            @ApiImplicitParam(name = "age", value = "用户年龄", dataType = "Integer"),
            @ApiImplicitParam(name = "user", value = "用户实体User(不填: 默认值)", dataType = "User", defaultValue = "User")
    })
    @RequestMapping(value = "/{id}", method = RequestMethod.PUT)
    public String putUser(@PathVariable Long id, @ModelAttribute User user){
        User u = users.get(id);
        u.setName(user.getName());
        u.setAge(user.getAge());
        users.put(id, u);
        return "success";
    }
 
    /**
     * 处理"/users/{id}" 的DELETE请求,用来删除User
     */
    @ApiOperation(value = "删除用户", notes = "根据url的id来指定删除的对象")
    @ApiImplicitParam(name = "id", value = "用户编号(必填)", required = true, dataType = "Long", paramType = "path")
    @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

验证Swagger2 UI文档

Swagger2构建RESTful (一)