Spring Boot实战:集成Swagger2

一、Swagger简介

  上一篇文章中我们介绍了Spring Boot对Restful的支持,这篇文章我们继续讨论这个话题,不过,我们这里不再讨论Restful API如何实现,而是讨论Restful API文档的维护问题。

  在日常的工作中,我们往往需要给前端(WEB端、IOS、Android)或者第三方提供接口,这个时候我们就需要给他们提供一份详细的API说明文档。但维护一份详细的文档可不是一件简单的事情。首先,编写一份详细的文档本身就是一件很费时费力的事情,另一方面,由于代码和文档是分离的,所以很容易导致文档和代码的不一致。这篇文章我们就来分享一种API文档维护的方式,即通过Swagger来自动生成Restuful API文档。

  那什么是Swagger?我们可以直接看下官方的描述:

THE WORLD'S MOST POPULAR API TOOLING
Swagger is the world’s largest framework of API developer tools for the OpenAPI Specification(OAS), 
enabling development across the entire API lifecycle, from design and documentation, to test and deployment.

  这段话首先告诉大家Swagger是世界上最流行的API工具,并且Swagger的目的是支撑整个API生命周期的开发,包括设计、文档以及测试和部署。这篇文章中我们会用到Swagger的文档管理和测试功能。

  对Swagger的作用有了基本的认识后,我们现在来看看怎么使用。

二、Swagger与Spring boot集成

  第一步:引入对应jar包:

 <dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.6.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.6.0</version>
</dependency>

  第二步,基本信息配置:

@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.pandy.blog.rest"))
                .paths(PathSelectors.regex("/rest/.*"))
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Blog系统Restful API")
                .description("Blog系统Restful API")
                .termsOfServiceUrl("http://127.0.0.1:8080/")
                .contact("liuxiaopeng")
                .version("1.0")
                .build();
    }

}

  基础的配置是对整个API文档的描述以及一些全局性的配置,对所有接口起作用。这里涉及到两个注解:

  @Configuration是表示这是一个配置类,是JDK自带的注解,前面的文章中也已做过说明。

  @EnableSwagger2的作用是启用Swagger2相关功能。

  在这个配置类里面我么实例化了一个Docket对象,这个对象主要包括三个方面的信息:

    (1)整个API的描述信息,即ApiInfo对象包括的信息,这部分信息会在页面上展示。

    (2)指定生成API文档的包名。

    (3)指定生成API的路径。按路径生成API可支持四种模式,这个可以参考其源码:

public class PathSelectors {
    private PathSelectors() {
        throw new UnsupportedOperationException();
    }

    public static Predicate<String> any() {
        return Predicates.alwaysTrue();
    }

    public static Predicate<String> none() {
        return Predicates.alwaysFalse();
    }

    public static Predicate<String> regex(final String pathRegex) {
        return new Predicate<String>() {
            public boolean apply(String input) {
                return input.matches(pathRegex);
            }
        };
    }

    public static Predicate<String> ant(final String antPattern) {
        return new Predicate<String>() {
            public boolean apply(String input) {
                AntPathMatcher matcher = new AntPathMatcher();
                return matcher.match(antPattern, input);
            }
        };
    }
}

  从源码可以看出,Swagger总共支持任何路径都生成、任何路径都不生成以及正则匹配和ant 模式匹配四种方式。大家可能比较熟悉的是前三种,最后一种ant匹配,如果不熟悉ant的话就直接忽略吧,前三种应该足够大家在日常工作中使用了。

  有了上面的配置我们就可以看到效果了,我在com.pandy.blog.rest这个包下面有一个ArticleRestController这个类,源码如下:

@RestController
public class ArticleRestController {

    @Autowired
    private ArticleService articleService;

    @RequestMapping(value = "/rest/article", method = POST, produces = "application/json")
    public WebResponse<Map<String, Object>> saveArticle(@RequestBody Article article) {
        article.setUserId(1L);
        articleService.saveArticle(article);
        Map<String, Object> ret = new HashMap<>();
        ret.put("id", article.getId());
        WebResponse<Map<String, Object>> response = WebResponse.getSuccessResponse(ret);
        return response;
    }

    @RequestMapping(value = "/rest/article/{id}", method = DELETE, produces = "application/json")
    public WebResponse<?> deleteArticle(@PathVariable Long id) {
        Article article = articleService.getById(id);
        article.setStatus(-1);
        articleService.updateArticle(article);
        WebResponse<Object> response = WebResponse.getSuccessResponse(null);
        return response;
    }

    @RequestMapping(value = "/rest/article/{id}", method = PUT, produces = "application/json")
    public WebResponse<Object> updateArticle(@PathVariable Long id, @RequestBody Article article) {
        article.setId(id);
        articleService.updateArticle(article);
        WebResponse<Object> response = WebResponse.getSuccessResponse(null);
        return response;
    }

    @RequestMapping(value = "/rest/article/{id}", method = GET, produces = "application/json")
    public WebResponse<Article> getArticle(@PathVariable Long id) {
        Article article = articleService.getById(id);
        WebResponse<Article> response = WebResponse.getSuccessResponse(article);
        return response;
    }

    @RequestMapping(value = "/test/{id}", method = GET, produces = "application/json")
    public WebResponse<?> getNoApi(){
        WebResponse<?> response = WebResponse.getSuccessResponse(null);
        return response;
    }
}

  启动Spring boot,然后访问:http://127.0.0.1:8080/swagger-ui.html即可看到如下结果:

   这个页面上可以看到,除了最后一个接口/test/{id}外,其他接口都生成对应的文档,最后一个接口因为不满足我们配置的路径——“/rest/.*”,所以没有生成文档。

  我们还可以点进去看一下每一个具体的接口,我们这里以“POST /rest/article”这个接口为例:

  可以看到,Swagger为每一个接口都生成了返回结果和请求参数的示例,并且能直接通过下面的"try it out"进行接口访问,方面大家对接口进行测试。整体上感觉Swagger还是很强大的,配置也比较简单。

三、Swagger API详细配置

   不过大家看到这里肯定会有点疑问:

    第一个问题:这个返回结果和请求参数都没有文字性的描述,这个可不可以配置?

    第二个问题:这个请求参应该是直接根据对象反射出来的结果,但是不是对象的每个属性都是必传的,另外参数的值也不一定满足我们的需求,这个能否配置?

  答案肯定是可以的,现在我们就来解决这两个问题,直接看配置的代码:

package com.pandy.blog.rest;

import com.pandy.blog.dto.WebResponse;
import com.pandy.blog.po.Article;
import com.pandy.blog.service.ArticleService;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Profile;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

import static org.springframework.web.bind.annotation.RequestMethod.DELETE;
import static org.springframework.web.bind.annotation.RequestMethod.GET;
import static org.springframework.web.bind.annotation.RequestMethod.POST;
import static org.springframework.web.bind.annotation.RequestMethod.PUT;

@RestController
@RequestMapping("/rest")
public class ArticleRestController {

    @Autowired
    private ArticleService articleService;

    @RequestMapping(value = "/article", method = POST, produces = "application/json")
    @ApiOperation(value = "添加文章", notes = "添加新的文章", tags = "Article",httpMethod = "POST")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "title", value = "文章标题", required = true, dataType = "String"),
            @ApiImplicitParam(name = "summary", value = "文章摘要", required = true, dataType = "String"),
            @ApiImplicitParam(name = "status", value = "发布状态", required = true, dataType = "Integer")
    })
    @ApiResponses({
            @ApiResponse(code=200,message="成功",response=WebResponse.class),
    })
    public WebResponse<Map<String,Object>> saveArticle(@RequestBody Article article){
        articleService.saveArticle(article);
        Map<String,Object> ret = new HashMap<>();
        ret.put("id",article.getId());
        WebResponse<Map<String,Object>> response = WebResponse.getSuccessResponse(ret);
        return response;
    }

    @ApiOperation(value = "删除文章", notes = "根据ID删除文章", tags = "Article",httpMethod = "DELETE")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "文章ID", required = true, dataType = "Long")
    })
    @RequestMapping(value = "/{id}",method = DELETE,produces = "application/json")
    public WebResponse<?>  deleteArticle(@PathVariable Long id){
        Article article = articleService.getById(id);
        article.setStatus(-1);
        articleService.saveArticle(article);
        return WebResponse.getSuccessResponse(new HashMap<>());
    }

    @ApiOperation(value = "获取文章列表", notes = "可以根据标题进行模糊查询", tags = "Article",httpMethod = "GET")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "title", value = "文章标题", required = false, dataType = "String"),
            @ApiImplicitParam(name = "pageSize", value = "每页文章数量", required = false, dataType = "Integer"),
            @ApiImplicitParam(name = "pageNum", value = "分页的页码", required = false, dataType = "Integer")
    })
    @RequestMapping(value = "/article/list", method = GET, produces = "application/json")
    public WebResponse<?> listArticles(String title, Integer pageSize, Integer pageNum) {
        if (pageSize == null) {
            pageSize = 10;
        }
        if (pageNum == null) {
            pageNum = 1;
        }
        int offset = (pageNum - 1) * pageSize;
        List<Article> articles =  articleService.getArticles(title, 1L, offset, pageSize);
        return WebResponse.getSuccessResponse(articles);
    }


    @ApiOperation(value = "更新文章", notes = "更新文章内容", tags = "Article",httpMethod = "PUT")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "文章ID", required = true, dataType = "Long"),
            @ApiImplicitParam(name = "title", value = "文章标题", required = false, dataType = "String"),
            @ApiImplicitParam(name = "summary", value = "文章摘要", required = false, dataType = "String"),
            @ApiImplicitParam(name = "status", value = "发布状态", required = false, dataType = "Integer")
    })
    @RequestMapping(value = "/article/{id}", method = PUT, produces = "application/json")
    public WebResponse<?> updateArticle(@PathVariable Long id,@RequestBody Article article){
        article.setId(id);
        articleService.updateArticle(article);
        return WebResponse.getSuccessResponse(new HashMap<>());
    }

}

  我们解释一下代码中几个注解及相关属性的具体作用:

  @ApiOperation,整个接口属性配置:

    value:接口说明,展示在接口列表。

    notes:接口详细说明,展示在接口的详情页。

    tags:接口的标签,相同标签的接口会在一个标签页下展示。

    httpMethod:支持的HTTP的方法。

  @ApiImplicitParams,@ApiImplicitParam的容器,可包含多个@ApiImplicitParam注解

  @ApiImplicitParam,请求参数属性配置:

    name:参数名称

    value:参数说明

    required:是否必须

    dataType:数据类型  

  @ApiResponses,@ApiResponse容器,可以包含多个@ApiResponse注解

  @ApiResponse,返回结果属性配置:

    code:返回结果的编码。

    message:返回结果的说明。

    response:返回结果对应的类。    

  完成以上配置后,我们再看下页面效果:

列表页:

   可以看到,现在接口都位于Article这个tag下,并且接口后面也有了我们配置好的说明。我们再看下”POST /rest/article“这个接口的详情页:

  图片太大,只截取了title属性的展示,其他几个参数的类似。我们可以从页面上看到请求参数的说明是有的,不过这不是我们预期的效果,如果我们的参数仅仅是简单类型,这种方式应该没问题,但现在的问题是我们的请求参数是一个对象,那如何配置呢?这就涉及到另外两个注解:@ApiModel和@ApiModelProperty,我们还是先看代码,然后再解释,这样更容易理解:

@ApiModel(value="article对象",description="新增&更新文章对象说明")
public class Article {

    @Id
    @GeneratedValue
    @ApiModelProperty(name = "id",value = "文章ID",required = false,example = "1")
    private Long id;

    @ApiModelProperty(name = "title",value = "文章标题",required = true,example = "测试文章标题")
    private String title;

    @ApiModelProperty(name = "summary",value = "文章摘要",required = true,example = "测试文章摘要")
    private String summary;

    @ApiModelProperty(hidden = true)
    private Date createTime;

    @ApiModelProperty(hidden = true)
    private Date publicTime;

    @ApiModelProperty(hidden = true)
    private Date updateTime;

    @ApiModelProperty(hidden = true)
    private Long userId;

    @ApiModelProperty(name = "status",value = "文章发布状态",required = true,example = "1")
    private Integer status;

    @ApiModelProperty(name = "type",value = "文章分类",required = true,example = "1")
    private Integer type;
}

  @ApiModel是对整个类的属性的配置:

    value:类的说明

    description:详细描述

  @ApiModelProperty是对具体每个字段的属性配置:

    name:字段名称

    value:字段的说明

    required:是否必须

    example:示例值

    hidden:是否显示

  完成上面的配置后,我们再来看效果:

  现在我们可以看到,字段的说明都已经展示出来,并且,示例中字段的值也变成了我们配置的example属性对应的值了。这样,一份完整的API文档就生成了,并且该文档与代码紧密的联系在一起,而不是隔离的两个部分。除此之外,我们还可以直接通过该文档很方便的进行测试,我们只需要点击Example Value下黄色的框,里面的内容就会自动复制到article对应的value框中,然后在点击“Try it out”就可以发起http请求了。

  点击Try it out后,我们就可以看到返回的结果:

  操作还是很方便的,相比Junit和postman,通过Swagger来测试会更加便捷,当然,Swagger的测试并不能代替单元测试,不过,在联调的时候还是有非常大的作用的。

四、总结

  总体上来说,Swagger的配置还是比较简单的,并且Swagger能够自动帮我们生成文档确实为我们节省了不少工作,对后续的维护也提供了很大的帮助。除此之外,Swagger还能根据配置自动为我们生成测试的数据,并且提供对应的HTTP方法,这对我们的自测和联调工作也有不少的帮助,所以我还是推荐大家在日常的开发中去使用Swagger,应该可以帮助大家在一定程度上提高工作效率的。最后,留一个问题给大家思考吧,就是该文档是可以直接通过页面来访问的,那我们总不能把接口直接暴露在生产环境吧,尤其是要对外提供服务的系统,那我们怎么才能在生产环节中关闭这个功能呢?方法有很多,大家可以自己尝试一下。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏Ryan Miao

SpringCloud学习5-如何创建一个服务提供者provider

1033
来自专栏IT笔记

SpringBoot开发案例之整合Swagger篇

前段时间整合过的一个支付服务,由于使用了Spring Boot快速开发,但是又懒得写详细的文档介绍,便顺手就把Swagger整合进来了,对支付服务进行分组API...

2597
来自专栏流媒体

SpringBoot集成Swagger2

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来...

643
来自专栏程序猿DD

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

由于Spring Boot能够快速开发、便捷部署等特性,相信有很大一部分Spring Boot的用户会用来构建RESTful API。而我们构建RESTful ...

2385
来自专栏刘君君

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

3027
来自专栏后端之路

SpringBoot来自Swagger的Restful文档生成

背景 基于SpringBoot的方案普遍要做到前后端分离 代码即文档 代码变化太快 文档经常忘记更改 方案 基于Swagger的方案可以比较简单的基于restf...

2249
来自专栏ImportSource

微服务RESTful接口文档生成神器Swagger初探

在微服务构建的过程中,你也许发现写的那些restful风格的接口需要编写文档。 文档一般包括要输入哪些参数,哪些参数是必填的,哪些是选填的。还有返回结果的格式...

3217
来自专栏一个会写诗的程序员的博客

《Spring Boot极简教程》第14章 Spring Boot集成Swagger2构建自动化Rest API文档小结

在以往的项目中,关于API接口文档,我们一般使用wiki或者干脆就是“线下文档”。缺点是很明显的:在迭代开发过程中,API会频繁变动,这样文档需要同步修改。繁琐...

683
来自专栏IT笔记

SpringBoot开发案例之整合Swagger篇

前段时间整合过的一个支付服务,由于使用了Spring Boot快速开发,但是又懒得写详细的文档介绍,便顺手就把Swagger整合进来了,对支付服务进行分组API...

4025
来自专栏专注于主流技术和业务

REST API文档工具Swagger2,以及与SpringBoot的集成

swagger是一个API框架,号称世界上最流行的API工具。它提供了API管理的全套解决方案,比如API在线编辑器,APIUI展示界面,代码生成器等诸多功能。...

672

扫码关注云+社区