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

约定不等于承诺〃 2022-02-01 15:21 219阅读 0赞

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

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

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

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dldGVyX2Ryb3A_size_16_color_FFFFFF_t_70]  
下面来具体介绍，如果在Spring Boot中使用Swagger2。首先，我们需要一个Spring Boot实现的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。

package com.ratel.generator;
    
    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;
    
    /** * @业务描述： * @package_name： com.ratel.generator * @project_name： mybatis-plus-generator * @author： ratelfu@qq.com * @create_time： 2019-05-14 17:01 * @copyright (c) ratelfu 版权所有 */
    
    @Configuration
    @EnableSwagger2
    public class Swagger2 { 
    
        @Bean
        public Docket createRestApi() { 
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.ratel.generator.controller"))
                    .paths(PathSelectors.any())
                    .build();
        }
    
        private ApiInfo apiInfo() { 
            return new ApiInfoBuilder()
                    .title("Spring Boot中使用Swagger2构建RESTful APIs")
                    .description("更多相关文章请关注：https://blog.csdn.net/weter_drop/")
                    .termsOfServiceUrl("https://blog.csdn.net/weter_drop/")
                    .contact("ratelfu")
                    .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.ratel.generator.controller;
    
    
    import com.ratel.generator.entity.User;
    import com.ratel.generator.service.IUserService;
    import io.swagger.annotations.ApiImplicitParam;
    import io.swagger.annotations.ApiOperation;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.*;
    
    import java.util.List;
    
    /** * <p> * 前端控制器 * </p> * * @author ratel * @since 2018-11-30 */
    @RestController
    @RequestMapping("/generator/user")
    public class UserController { 
    
        @Autowired
        private IUserService iUserService;
    
        @ApiOperation(value="获取所有用户")
        @GetMapping("/list")
        public List<User> list() { 
            List<User> users = iUserService.list(null);
            return users;
        }
    
        @ApiOperation(value="保存用户")
        @GetMapping("/save")
        public String save() { 
            User user = new User();
            // user.setId(7);
            user.setAge(18);
            user.setName("马云");
            user.setEmail("杭州师范");
            iUserService.save(user);
            return "success";
        }
    
        @ApiOperation(value="根据用户名获取用户", notes="根据用户的姓名获取用户")
        @GetMapping("/selectByName/{name}")
        public User selectByName(@PathVariable String name) { 
            System.out.println(name);
            User user = iUserService.selectByName(name);
            return user;
        }
    
        //@ApiOperation(value="根据用户名获取用户", notes="根据用户的姓名获取用户")
        //@ApiImplicitParam(name = "name", value = "用户名")
        @ApiOperation("根据用户名获取用户")
        @GetMapping("/selectByName2")
        public User selectByName2(@RequestParam String name) { 
            User user = iUserService.selectByName(name);
            return user;
        }
    }

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

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dldGVyX2Ryb3A_size_16_color_FFFFFF_t_70 1]

### API文档访问与调试 ###

在上图请求的页面中，我们看到user的Value是个输入框？是的，Swagger除了查看接口功能外，还提供了调试测试功能，我们可以点击上图中右侧的Model Schema（黄色区域：它指明了User的数据结构），此时Value中就有了user对象的模板，我们只需要稍适修改，点击下方“Try it out！”按钮，即可完成了一次请求调用！

此时，你也可以通过几个GET请求来验证之前的POST请求是否正确。

相比为这些接口编写文档的工作，我们增加的配置内容是非常少而且精简的，对于原有代码的侵入也在忍受范围之内。因此，在构建RESTful API的同时，加入swagger来对API文档进行管理，是个不错的选择。

完整项目地址：https://github.com/Dr-Water/mybatis-plus-generator

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dldGVyX2Ryb3A_size_16_color_FFFFFF_t_70]: /images/20220201/18100e0357d14b498a698620b22f920c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dldGVyX2Ryb3A_size_16_color_FFFFFF_t_70 1]: /images/20220201/fcb5d98ec7954623bf3be30abf72debd.png