请选择 进入手机版 | 继续访问电脑版
本站特色:极好的技术研究氛围!所有技术交流,必有回复!

疯狂Java联盟

 找回密码
 加入联盟
查看: 463|回复: 1

使用Swagger2构建强大的RESTful API文档(1)

[复制链接]
发表于 2018-6-25 17:49:40 | 显示全部楼层 |阅读模式

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

swagger2_1.png

下面来具体介绍,如果在Spring Boot中使用Swagger2。首先,我们需要一个Spring Boot实现的RESTful API工程,若您没有做过这类内容,建议先阅读
Spring Boot构建一个较为复杂的RESTful APIs和单元测试

下面的内容我们会以教程样例中的Chapter3-1-1进行下面的实验(Chpater3-1-5是我们的结果工程,亦可参考)。

添加Swagger2依赖

在pom.xml中加入Swagger2的依赖

  1. <dependency>  
  2.     <groupId>io.springfox</groupId>  
  3.     <artifactId>springfox-swagger2</artifactId>  
  4.     <version>2.2.2</version>  
  5. </dependency>  
  6. <dependency>  
  7.     <groupId>io.springfox</groupId>  
  8.     <artifactId>springfox-swagger-ui</artifactId>  
  9.     <version>2.2.2</version>  
  10. </dependency>  
复制代码
创建Swagger2配置类

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

  1. @Configuration  
  2. @EnableSwagger2  
  3. public class Swagger2 {  
  4.   
  5.     @Bean  
  6.     public Docket createRestApi() {  
  7.         return new Docket(DocumentationType.SWAGGER_2)  
  8.                 .apiInfo(apiInfo())  
  9.                 .select()  
  10.                 .apis(RequestHandlerSelectors.basePackage("com.didispace.web"))  
  11.                 .paths(PathSelectors.any())  
  12.                 .build();  
  13.     }  
  14.   
  15.     private ApiInfo apiInfo() {  
  16.         return new ApiInfoBuilder()  
  17.                 .title("Spring Boot中使用Swagger2构建RESTful APIs")  
  18.                 .description("更多Spring Boot相关文章请关注:http://blog.didispace.com/")  
  19.                 .termsOfServiceUrl("http://blog.didispace.com/")  
  20.                 .contact("程序猿DD")  
  21.                 .version("1.0")  
  22.                 .build();  
  23.     }  
  24.   
  25. }  
复制代码

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

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


swagger.png
 楼主| 发表于 2018-6-25 17:50:08 | 显示全部楼层
欢迎大家一起交流~~
您需要登录后才可以回帖 登录 | 加入联盟

本版积分规则

微信群请扫二维码
QQ交流1群:
545923995
(未满)

小黑屋|手机版|Archiver|疯狂Java联盟 ( 粤ICP备11094030号 )

GMT+8, 2020-3-31 23:55 , Processed in 0.332961 second(s), 8 queries , File On.

快速回复 返回顶部 返回列表