Spring Boot中怎样使用Swagger2构建RESTful API文档

本文介绍了如何使用Swagger2在Spring Boot构建RESTful API文档。内容非常详细，有兴趣的朋友可以参考一下，希望对你有帮助。

由于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。具体效果如下图所示：

这里，如果你在Spring Boot使用Swagger2。首先，我们需要一个由Spring Boot实现的RESTful API项目。

00-1010在pom.xml中添加Swagger2依赖项

属国

groupIdio.springfox/groupId

artifactIdspringfox-swagger 2/artifactId

版本2 . 2 . 2/版本

/依赖性

属国

groupIdio.springfox/groupId

artifactIdspringfox-swag-ui/artifactId

版本2 . 2 . 2/版本

/dependency

添加Swagger2依赖

在Application.java的同一级别创建Swagger2的配置类Swagger2。

@配置

@EnableSwagger2

公共类Swagger2 {

@豆

public Docket create restapi(){ 0

返回新的Docket(document type。SWAGGER _ 2)。apiInfo(apiInfo())。选择()。API(RequestHandlerSelectors . BasePackage(' com . didis space . web ')。路径(路径选择器. any(

))
               .build();
   }    
   private ApiInfo apiInfo() {        
       return new ApiInfoBuilder()
               .title("Spring Boot中使用Swagger2构建RESTful APIs")
               .description("desc")
               .termsOfServiceUrl("http://blog.didispace.com/")
               .contact("程序猿DD")
               .version("1.0")
               .build();
   }
}

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

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

添加文档内容

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

@RestController
@RequestMapping(value="/users")     
// 通过这里配置使下面的映射都在/users下，可去除
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> 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, 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, 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.setName(user.getName());
        u.setAge(user.getAge());
        users.put(id, u);        
        return "success";
    }    
    
    @ApiOperation(value="删除用户", notes="根据url的id来指定删除对象")        @ApiImplicitParam(name = "id", value = "用户ID", required = true, 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的页面。我们可以再点开具体的API请求，以POST类型的/users请求为例，可找到上述代码中我们配置的Notes信息以及参数user的描述信息，如下图所示。

API文档访问与调试

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

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

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

关于Spring Boot中怎样使用Swagger2构建RESTful API文档就分享到这里了，希望