Spring Boot从零入门6_Swagger2生成生产环境中REST API文档

本文属于原创,转载注明出处,欢迎关注微信小程序小白AI博客 和微信公众号别打名名或者网站 https://xiaobaiai.net 或者我的CSDN http://blog.csdn.net/freeape

  • 1 前言

  • 2 Swagger2简介

  • 3 开始使用

  • 3.1 构建Restful WEB服务

  • 3.2 集成Swagger2

  • 3.3 集成Swagger2 UI

  • 4 Swagger2 深度配置

  • 4.1 深度配置目标

  • 4.2 文档信息配置

  • 4.3 API分组配置、API精细配置

  • 4.4 API历史版本管理

  • 4.5 其他配置

  • 5 总结

  • 6 参考文档

1 前言

在如今前后端分离开发的模式下,前端调用后端提供的API去实现数据的展示或者相关的数据操作,保证及时更新和完整的REST API文档将会大大地提高两边的工作效率,减少不必要的沟通成本。本文采用的Swagger2就是一个当前流行的通过少量的注解就可以生成漂亮的API文档工具,且在生成的在线文档中提供类似POSTMAN直接调试能力,不仅仅是静态的文档。接下来将会利用这个工具与Spring Boot项目结合,最终生成我们上一篇文章中所涉及到的REST API文档。

这一篇文章基本将Swagger2在生产环境中可能会用到的配置都有涉及,慢慢看吧,看了这一篇因该是够了。

2 Swagger2简介

Swagger是与用于实现 OpenAPI 文档广泛使用的工具,Swagger工具集包括开源工具,免费工具和商业工具的组合,可在API生命周期的不同阶段使用。

  • Swagger Editor(开源):使用Swagger编辑器,可以在浏览器内的YAML文档中编辑OpenAPI规范并支持实时预览文档,可以参考官方的Demo https://editor.swagger.io/

  • Swagger UI(开源):让Swagger产生的文档更漂亮,而且支持API交互操作,在生成文档后,直接在浏览器中浏览,并可以实现类似 curl命令或者 postman访问我们的API,并返回相关数据。

  • Swagger Codegen(开源): 是一个代码生成器,可以通过Swagger API定义生成不同语言版本的服务端和客户端工程代码。

  • Swagger Core(开源):用于生成Swagger API规范的示例和服务器集成,可轻松访问REST API,结合 Swagger UI,让生成的文档更漂亮。

  • Swagger Parser(开源):Java开发,解析OpenAPI定义的独立库

  • Swagger Inspector(免费):API在线测试工具,验证API并从现有API生成OpenAPI定义功能 https://goo.gl/fZYHWz

  • SwaggerHub(免费和商用版):API设计和文档化,为使用OpenAPI的团队打造。

3 开始使用

3.1 构建Restful WEB服务

参考《Spring Boot从零入门5_五脏俱全的RESTful Web Service构建》。构建好后有如下REST API:

# 获取所有用户信息GET http://localhost:8080/api/v1/users# 新增一个用户,参数通过body传递POST http://localhost:8080/api/v1/users# 更新一个用户信息PUT http://localhost:8080/api/v1/users/{id}# 删除指定用户DELETE http://localhost:8080/api/v1/users/{id}

3.2 集成Swagger2

构建好RESTful WEB服务后,接下来我们集成Swagger,然后对上节中的REST API自动生成接口文档。

3.2.1 pom.xml添加依赖

集成Swagger2,需要在pom.xml中添加依赖源:

<dependencies> <dependency>     <groupId>io.springfox</groupId>     <artifactId>springfox-swagger2</artifactId>     <!-- 截至2019年11月7日为止,最新版本为2.9.2 -->     <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->     <version>2.9.2</version> </dependency></dependencies>

3.2.2 Swagger 配置及初始化

springfox有一个专用对象Docket,可以灵活的配置Swagger的各种属性,首先我们简单的创建一个Swagger配置类Swagger2Config.java:

@Configuration@EnableSwagger2public class Swagger2Config {    @Bean("UsersApis")    public Docket usersApis() {        return new Docket(DocumentationType.SWAGGER_2)                .select()                .apis(RequestHandlerSelectors.any())                .paths(PathSelectors.any())                .build();    }}

这里的@Configuration注解用于定义配置类,被注解的类内部包含有一个或多个被@Bean注解的方法,这些方法将会被AnnotationConfigApplicationContext类进行扫描,并用于构建Bean定义,初始化对象。@ComponentScan会自动获取所有的Spring Components,包括@Configuration类。另外这里的“用户管理模块”API生成配置很简单,对所有路径上API都去生成文档。

3.2.3 启动服务并验证

当完成Swagger2的配置类时,启动WEB服务,通过http://localhost:8080/v2/api-docs就可以访问生成文档内容,但是浏览器返回的是JSON内容,基本上很难给需要用到相关API的开发人员进行参考。这个时候就需要用到`Swagger2 UI`了。

3.3 集成Swagger2 UI

pom.xml添加依赖,然后重启WEB服务就可以了,再次访问http://localhost:8080/swagger-ui.html,这时候看到的就是WEB文档了。

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

从swagger-ui页面看到的内容有一部无关的内容,或者是如何明显表现跟项目相关的内容呢?下面章节详细讲解Swagger的各种配置,能够应用到实际生产环境中去。

4 Swagger2 深度配置

4.1 深度配置目标

首先,如果要将我们最后生成的API文档给生产环境的开发人员查阅,那么友好的展示信息和归类是很有必要的,我们接下来实现如下目标:

  • 文档的各种信息说明

  • 文档标题

  • 文档描述

  • 文档版本号

  • Logo

  • 文档责任人

  • 文档许可证信息

  • 文档服务条款

  • API分组

  • 组描述

  • 各API描述

  • 附加部分(非API)

  • 定制化文档页面风格

为了更好地展示API分组功能,这里另外加了一组REST API (代码层面上只需要将User相关的代码全部复制一份,将User关键字全部改为Product就可以了,包括大小写):

# 获取所有产品信息GET http://localhost:8080/api/v1/products# 新增一个产品,参数通过body传递POST http://localhost:8080/api/v1/products# 更新一个产品信息PUT http://localhost:8080/api/v1/products/{id}# 删除指定产品DELETE http://localhost:8080/api/v1/products/{id}

4.2 文档信息配置

@Configuration@EnableSwagger2public class Swagger2Config {    @Bean("UsersApis")    public Docket usersApis() {        return new Docket(DocumentationType.SWAGGER_2)          // select()返回的是ApiSelectorBuilder对象,而非Docket对象                .select()                .apis(RequestHandlerSelectors.any())                .paths(PathSelectors.any())                                 // build()返回的是Docket对象                .build()                // 测试API时的主机URL                .host("https://xiaobaiai.net")                    // API前缀                .pathProvider(new RelativePathProvider(null) {                    @Override                    public String getApplicationBasePath() {                        return "/prefix";                    }                })                .apiInfo(apiInfo());    }        public ApiInfo apiInfo() {     // API负责人的联系信息     final Contact contact = new Contact(       "Ethan", "https://xiaobaiai.net", "ycm_hy@163.com");        return new ApiInfoBuilder()         // API文档标题            .title("X系统平台接口文档")            // API文档描述            .description("用户/产品相关API, 更多请关注公众号: 小白AI 或微信小程序:小白AI博客")            // 服务条款URL            .termsOfServiceUrl("https://github.com/yicm")            // API文档版本            .version("1.0")            // API负责人的联系信息            .contact(contact)            // API的许可证Url            .licenseUrl("http://license.coscl.org.cn/MulanPSL")            .license("MulanPSL")            .build();    }}

通过添加文档信息编译对象ApiInfoBuilder可以配置API文档的各种信息,包括标题、描述、服务条款、版本、责任人、许可证等。最后在Docket中添加信息配置对象即可生效。

注意:host设置的是域名或IPV4 + 端口,如下,path和host以及scheme等定义。

4.3 API分组配置、API精细配置

4.3.1 API分组展示

上面的文档信息配置中默认是没有对API分组的,即所有的API都展示在了一个页面,没有隔离,如果需要分组,那我们需要对不同API组分配Bean,目前示例可以分为用户API组和产品API组,然后通过apis() 和 paths()进行API过滤。

为了不显示某个包下面API或某个URL路径下API, Docket提供了 apis() 和 paths() 两 个方法来帮助我们在不同级别上过滤接口(上面示例我们默认对这两个设置是不做任何过滤,扫描所有API):

  • apis():这种方式可以通过指定包名的方式,让 Swagger2 只去某些包下面扫描

  • paths():这种方式可以通过筛选 API 的 URL 来进行过滤

apis和paths中的Predicates除了any、ant、none,还支持regex正则表达式。

如:

PathSelectors.regex("/api/v2/users.*")

下面就是分组示例代码,实现分组,很简单,就是在Docket中配置组名就好了:

@Configuration@EnableSwagger2public class Swagger2Config {    @Bean    public Docket usersApis() {        return new Docket(DocumentationType.SWAGGER_2)          .groupName("用户管理接口")          // select()返回的是ApiSelectorBuilder对象,而非Docket对象                .select()                                .apis(RequestHandlerSelectors.basePackage("com.xiaobaiai.user"))                .paths(Predicates.or(                        // 两个**,可以匹配底下所有URL                        // 一个*,只能匹配一级URL分段                        PathSelectors.ant("/api/v1/users/**"),                        PathSelectors.ant("/api/v1/users/*")))                              // build()返回的是Docket对象                .build()                // 测试API时的主机URL                .host("https://xiaobaiai.net")                    // API前缀,最终所有API的基础地址就是host+prefix: https://xiaobaiai.net/prefix                .pathProvider(new RelativePathProvider(null) {                    @Override                    public String getApplicationBasePath() {                        return "/prefix";                    }                })                .apiInfo(apiInfo());    }        @Bean    public Docket productsApis() {        return new Docket(DocumentationType.SWAGGER_2)          .groupName("产品管理接口")          // select()返回的是ApiSelectorBuilder对象,而非Docket对象                .select()                                .apis(RequestHandlerSelectors.basePackage("com.xiaobaiai.product"))                .paths(Predicates.or(                        // 两个**,可以匹配底下所有URL                        // 一个*,只能匹配一级URL分段                        PathSelectors.ant("/api/v1/products/**"),                        PathSelectors.ant("/api/v1/products/*")))                              // build()返回的是Docket对象                .build()                // 测试API时的主机URL                .host("https://xiaobaiai.net")                    // API前缀                .pathProvider(new RelativePathProvider(null) {                    @Override                    public String getApplicationBasePath() {                        return "/prefix";                    }                })                .apiInfo(apiInfo());    }        public ApiInfo apiInfo() {     // API负责人的联系信息     final Contact contact = new Contact(       "Ethan", "https://xiaobaiai.net", "ycm_hy@163.com");        return new ApiInfoBuilder()         // API文档标题            .title("X系统平台接口文档")            // API文档描述            .description("用户/产品相关API, 更多请关注公众号: 小白AI 或微信小程序:小白AI博客")            // 服务条款URL            .termsOfServiceUrl("https://github.com/yicm")            // API文档版本            .version("1.0")            // API负责人的联系信息            .contact(contact)            // API的许可证Url            .licenseUrl("http://license.coscl.org.cn/MulanPSL")            .license("MulanPSL")            .build();    }}

分组配置完成后,重新启动,打开浏览器就可以看到效果了:

4.3.2 API精细配置

虽然上面我们已经可以控制API的显示和分组了,但是对于API一些更详细,对组内API再次归类之类的,比如小组的描述信息,以及每个API如何去控制它的参数说明,返回值说明等。这些都是通过注解去实现的,接下来我们讲述常用的注解及作用:

  1. @Api : 将这个注解添加到控制器类上,则可以给控制器添加描述类信息:

相关可设置参数有:

  • value:用作承载资源的API声明的“路径”,可以说是API URL的别名

  • tags:如果设置这个值、value的值会被覆盖

  • description:已过时,对api资源的描述

  • protocols:协议类型如: http, https, ws, wss.

  • hidden:配置为true ,隐藏此资源下的操作(试验了下,貌似无法生效,替代方案还是用@ApiIgnore吧)

  • produces:如 “application/json, application/xml”

  • consumes:如 “application/json, application/xml”

  • authorizations:高级特性认证时配置

示例:

// Swagger配置类@Configuration@EnableSwagger2public class Swagger2Config {@Bean    public Docket productsApis() {        return new Docket(DocumentationType.SWAGGER_2)          .groupName("产品管理接口")                .select()                .apis(RequestHandlerSelectors.basePackage("com.xiaobaiai.product"))                .paths(Predicates.or(                        PathSelectors.ant("/api/v1/products/**"),                        PathSelectors.ant("/api/v1/products/*")))                              .build()                .host("https://xiaobaiai.net")                    .pathProvider(new RelativePathProvider(null) {                    @Override                    public String getApplicationBasePath() {                        return "/prefix";                    }                })                .apiInfo(apiInfo())                .tags(new Tag("产品操作分组1", "产品查询相关操作."),                        new Tag("产品操作分组2", "产品添加或删除相关操作."),                        new Tag("产品操作分组3", "产品更新相关操作."),                        new Tag("产品操作分组4", "产品相关全部操作."));    }}

// 控制器类@RestController@RequestMapping("/api/v1")@Api(tags={"产品接口文档列表"})public class ProductServiceController { ... }

效果如下:

  1. @ApiIgnore: 作用在REST API控制器 方法上,则该API不会被显示出来:

    @ApiIgnore@RequestMapping(value = "/users/{id}", method = RequestMethod.DELETE)public ResponseEntity

评论

暂无评论