Spring Boot 使用Swagger2构建RESTful API

在这里插入图片描述

Swagger2是什么？

Swagger2，它可以轻松的整合到Spring Boot中，并与Spring MVC程序配合组织出强大RESTful API文档。它既可以减少我们创建文档的工作量，同时说明内容又整合入实现代码中，让维护文档和修改代码整合为一体，可以让我们在修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了强大的页面测试功能来调试每个RESTful API。具体效果如下图所示：
在这里插入图片描述

Spring Boot开发

由于Spring Boot能够快速开发、便捷部署等特性，相信有很大一部分Spring Boot的用户会用来构建RESTful
API。而我们构建RESTful API的目的通常都是由于多终端的原因，这些终端会共用很多底层业务逻辑，因此我们会抽象出这样一层来同时服务于多个移动端或者Web前端。

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

由于接口众多，并且细节复杂（需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等），高质量地创建这份文档本身就是件非常吃力的事，下游的抱怨声不绝于耳。
随着时间推移，不断修改接口实现的时候都必须同步修改接口文档，而文档与代码又处于两个不同的媒介，除非有严格的管理机制，不然很容易导致不一致现象。

开发案例

项目结构

在这里插入图片描述

pojo类

public class User {
    private  String id;
    private  String name;
    private  String age;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getAge() {
        return age;
    }

    public void setAge(String age) {
        this.age = age;
    }
}

添加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.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建该Api的基本信息（这些信息会展示在页面中）
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2构建RESTful APIs")
                .description("Spring Boot 中使用restful使用指南")
                .termsOfServiceUrl("http://wusha.github.io.com")
                .contact("ss")
                .version("1.0")
                .build();
    }
}

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

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

controller层

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

@RestController
@RequestMapping(value = "/users")
public class UserController {

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

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

    @ApiOperation(value = "新增用户",notes = "")
    @ApiImplicitParam(name = "user",value = "用户实体",required = true,dataType = "User")
    @RequestMapping(value = "",method = RequestMethod.POST)
    public String add(@RequestBody User user){
        users.put(user.getId(),user);
        return  "success";
    }

   /**
     *
     * @param id
     * @return
     */
    @ApiOperation(value = "查询根据id",notes = "")
    @ApiImplicitParam(name = "id",value = "用户id",required = true,dataType = "String",paramType = "path")
    @RequestMapping(value = "/{id}",method = RequestMethod.GET)
    public User findById(@PathVariable String id){
        return  users.get(id);
    }



    @ApiOperation(value = "修改用户信息",notes = "")
    @ApiImplicitParam(name = "user",value = "用户实体",required = true,dataType = "User")
    @RequestMapping(value = "/{id}",method = RequestMethod.PUT)
    public String update(@PathVariable String id,@RequestBody User user){
        User user1 = users.get(id);
        user1.setAge(user.getAge());
        user1.setName(user.getName());
        return "success";
    }

    @ApiOperation(value = "根据id删除用户",notes = "")
    @ApiImplicitParam(name = "id",value = "用户id",required = true,dataType = "String",paramType = "path")
    @RequestMapping(value = "/{id}",method = RequestMethod.DELETE)
    public String delete(@RequestBody String id){
        users.remove(id);
        return  "success";
    }
}

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