原文链接：公众号狂神说

项目集成Swagger

学习目标：

• 了解Swagger的概念及作用

• 掌握在项目中集成Swagger自动生成API文档

Swagger简介

前后端分离

• 前端 -> 前端控制层、视图层

• 后端 -> 后端控制层、服务层、数据访问层

• 前后端通过API进行交互

• 前后端相对独立且松耦合

产生的问题

• 前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发

解决方案

• 首先定义schema [ 计划的提纲 ]，并实时跟踪最新的API，降低集成风险

Swagger

• 号称世界上最流行的API框架

• Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新

• 直接运行，在线测试API

• 支持多种语言 （如：Java，PHP等）

• 官网：https://swagger.io/

SpringBoot集成Swagger

SpringBoot集成Swagger => springfox，两个jar包

• Springfox-swagger2

• swagger-springmvc

使用Swagger

要求：jdk 1.8 + 否则swagger2无法运行

步骤：

1、新建一个SpringBoot-web项目

2、添加Maven依赖

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

3、编写HelloController，测试确保运行成功！

4、要使用Swagger，我们需要编写一个配置类-SwaggerConfig来配置 Swagger

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {  
}

5、访问测试 ：http://localhost:8080/swagger-ui.html ，可以看到swagger的界面；

配置Swagger

1、Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swaggger。

@Bean //配置docket以配置Swagger具体参数
public Docket docket() {return new Docket(DocumentationType.SWAGGER_2);
}

2、可以通过apiInfo()属性配置文档信息

    //配置 Swagger 信息 apiInfopublic ApiInfo apiInfo() {//作者信息Contact contact = new Contact("小叶曲", "https://littlesheep.club/", "145843299@qq.com");return new ApiInfo("小叶曲 日记",   // 标题"啦啦啦",  // 描述"v1.0",  // 版本"https://littlesheep.club/",     // 组织链接contact,     // 联系人信息"Apache 2.0 许可",    // 联系人信息"http://www.apache.org/licenses/LICENSE-2.0",    // 许可连接new ArrayList())    // 扩展;}

3、Docket 实例关联上 apiInfo()

@Bean
public Docket docket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}

4、重启项目，访问测试 http://localhost:8080/swagger-ui.html  看下效果；

配置扫描接口

1、构建Docket时通过select()方法配置怎么扫描接口。

    //配置了 Swagger 的 Docket 的 bean 实例@Beanpublic Docket docket(Environment environment) {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())//select() ... build() 是一套.select()   // 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口//要扫描接口的方式： RequestHandlerSelectors//               指定要扫描的包： basePackage//               指定要全部的包： any//               不扫描： none//               扫描类上的注解：   withClassAnnotation，参数是一个注解的反射的对象//               扫描方法上的注解： withMethodAnnotation.apis(RequestHandlerSelectors.basePackage("com.jia.swagger.controller")).build();}

2、重启项目测试，由于我们配置根据包的路径扫描接口，所以我们只能看到一个类

3、除了通过包路径配置扫描接口外，还可以通过配置其他方式扫描接口，这里注释一下所有的配置方式：

any() // 扫描所有，项目中的所有接口都会被扫描到
none() // 不扫描接口
// 通过方法上的注解扫描，如withMethodAnnotation(GetMapping.class)只扫描get请求
withMethodAnnotation(final Class<? extends Annotation> annotation)
// 通过类上的注解扫描，如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口
withClassAnnotation(final Class<? extends Annotation> annotation)
basePackage(final String basePackage) // 根据包路径扫描接口

4、除此之外，我们还可以配置接口扫描过滤： 

    //配置了 Swagger 的 Docket 的 bean 实例@Beanpublic Docket docket(Environment environment) {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())//select() ... build() 是一套.select()   // 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口//要扫描接口的方式： RequestHandlerSelectors//               指定要扫描的包： basePackage//               指定要全部的包： any//               不扫描： none//               扫描类上的注解：   withClassAnnotation，参数是一个注解的反射的对象//               扫描方法上的注解： withMethodAnnotation.apis(RequestHandlerSelectors.basePackage("com.jia.swagger.controller"))//过滤请求的路径，只扫描带有 jia 请求下面的接口.paths(PathSelectors.ant("/jia/**")).build();}

5、这里的可选值还有

any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) // 通过正则表达式控制
ant(final String antPattern) // 通过ant()控制

 配置Swagger开关

1、通过enable()方法配置是否启用swagger，如果是false，swagger将不能在浏览器中访问了

    //配置了 Swagger 的 Docket 的 bean 实例@Beanpublic Docket docket(Environment environment) {//设置要显示的 Swagger 环境Profiles profiles = Profiles.of("dev","test");//获取项目的环境 通过 environment.acceptsProfiles 判断是否处在自己设定的环境中boolean flag = environment.acceptsProfiles(profiles);return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())//enable 是否启动swagger.enable(flag)//select() ... build() 是一套.select()   // 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口//要扫描接口的方式： RequestHandlerSelectors//               指定要扫描的包： basePackage//               指定要全部的包： any//               不扫描： none//               扫描类上的注解：   withClassAnnotation，参数是一个注解的反射的对象//               扫描方法上的注解： withMethodAnnotation.apis(RequestHandlerSelectors.basePackage("com.jia.swagger.controller"))//过滤请求的路径，只扫描带有 jia 请求下面的接口.paths(PathSelectors.ant("/jia/**")).build();}

配置API分组

1、如果没有配置分组，默认是default。通过groupName()方法即可配置分组：

    //配置了 Swagger 的 Docket 的 bean 实例@Beanpublic Docket docket(Environment environment) {//设置要显示的 Swagger 环境Profiles profiles = Profiles.of("dev");//获取项目的环境 通过 environment.acceptsProfiles 判断是否处在自己设定的环境中boolean flag = environment.acceptsProfiles(profiles);return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())//配置 API文档 的分组.groupName("小叶曲啦啦啦")//enable 是否启动swagger.enable(flag)//select() ... build() 是一套.select()   // 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口//要扫描接口的方式： RequestHandlerSelectors//               指定要扫描的包： basePackage//               指定要全部的包： any//               不扫描： none//               扫描类上的注解：   withClassAnnotation，参数是一个注解的反射的对象//               扫描方法上的注解： withMethodAnnotation.apis(RequestHandlerSelectors.basePackage("com.jia.swagger.controller"))//过滤请求的路径，只扫描带有 jia 请求下面的接口.paths(PathSelectors.ant("/jia/**")).build();}

2、重启项目查看分组

3、如何配置多个分组？配置多个分组只需要配置多个docket即可：

    @Beanpublic Docket docket1(Environment environment) {return new Docket(DocumentationType.SWAGGER_2).groupName("小叶曲耶耶耶1");}@Beanpublic Docket docket2(Environment environment) {return new Docket(DocumentationType.SWAGGER_2).groupName("小叶曲耶耶耶2");}@Beanpublic Docket docket3(Environment environment) {return new Docket(DocumentationType.SWAGGER_2).groupName("小叶曲耶耶耶3");}

4、重启项目查看即可

实体配置

1、新建一个实体类

package com.jia.swagger.pojo;import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;@ApiModel("用户实体类 ~")
public class User {@ApiModelProperty("用户名")public String username;@ApiModelProperty("密  码")public String password;public User(String username, String password) {this.username = username;this.password = password;}public String getUsername() {return username;}public void setUsername(String username) {this.username = username;}public String getPassword() {return password;}public void setPassword(String password) {this.password = password;}
}

2、只要这个实体在请求接口的返回值上（即使是泛型），都能映射到实体项中：

    //只要接口中 返回值存在实体类 就会被扫描到 Swagger 中@RequestMapping("/user")public User user() {return new User("qqq","123");}

3、重启查看测试

 注：并不是因为@ApiModel这个注解让实体显示在这里了，而是只要出现在接口方法的返回值上的实体都会显示在这里，而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。

@ApiModel为类添加注释

@ApiModelProperty为类属性添加注释

 常用注解

Swagger的所有注解定义在io.swagger.annotations包下

下面列一些经常用到的，未列举出来的可以另行查阅说明：

我们也可以给请求的接口配置一些注释

    //Operation 接口@ApiOperation("Get 控制类")@GetMapping("/jia/getName")public String getName(@ApiParam("用户名1") String username) {return "getName"+username;}@ApiOperation("Post 控制类")@PostMapping("/jia/postName")public String postName(@ApiParam("用户名2") String username) {return "postName"+username;}@ApiOperation("postUser 控制类")@PostMapping("/jia/postUser")public User postUser(User user) {return user;}

这样的话，可以给一些比较难理解的属性或者接口，增加一些配置信息，让人更容易阅读！

相较于传统的Postman或Curl方式测试接口，使用swagger简直就是傻瓜式操作，不需要额外说明文档(写得好本身就是文档)而且更不容易出错，只需要录入数据然后点击Execute，如果再配合自动化框架，可以说基本就不需要人为操作了。

Swagger是个优秀的工具，现在国内已经有很多的中小型互联网公司都在使用它，相较于传统的要先出Word接口文档再测试的方式，显然这样也更符合现在的快速迭代开发行情。当然了，提醒下大家在正式环境要记得关闭Swagger，一来出于安全考虑二来也可以节省运行时内存。

拓展：其他皮肤

我们可以导入不同的包实现不同的皮肤定义：

1、默认的   访问 http://localhost:8080/swagger-ui.html

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

2、bootstrap-ui  访问 http://localhost:8080/doc.html

<!-- 引入swagger-bootstrap-ui包 /doc.html-->
<dependency><groupId>com.github.xiaoymin</groupId><artifactId>swagger-bootstrap-ui</artifactId><version>1.9.1</version>
</dependency>

3、Layui-ui   访问 http://localhost:8080/docs.html

<!-- 引入swagger-ui-layer包 /docs.html-->
<dependency><groupId>com.github.caspar-chen</groupId><artifactId>swagger-ui-layer</artifactId><version>1.1.3</version>
</dependency>

4、mg-ui   访问 http://localhost:8080/document.html

<!-- 引入swagger-ui-layer包 /document.html-->
<dependency><groupId>com.zyplayer</groupId><artifactId>swagger-mg-ui</artifactId><version>1.0.6</version>
</dependency>

B站地址：https://space.bilibili.com/95256449