Swagger
- 了解Swagger的概念及作用
- 了解前后端分离
- 在springboot中集成swagger
Swagger简介
前后端分离
Vue+SpringBoot
后端时代:前端只用管理静态页面;html==>后端。模板引擎JSP=>后端才是主力
前后端分离时代
- 前端 -> 前端控制层、视图层
- 伪造后端数据,json。已经存在了,不需要后端,前端工程队依旧能够跑起来
- 后端 -> 后端控制层、服务层、数据访问层
- 前后端通过API进行交互
- 前后端相对独立且松耦合
- 前后端可以部署在不同的服务器上
产生的问题
- 前后端集成联调,前端或者后端无法做到“及时协商,尽早解决”,最终导致问题集中爆发
解决方案
- 首先定义schema [ 计划的提纲 ],并实时跟踪最新的API,降低集成风险;
- 早些年:指定word计划文档;
- 前后端分离:
- 前端测试后端接口:postman
- 后端提供接口,需要实时更新最新的消息及改动
了解Swagger
- 号称世界上最流行的API框架
- Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新
- 直接运行,在线测试API
- 支持多种语言 (如:Java,PHP等)
- 官网:https://swagger.io/
SpringBoot集成Swagger
SpringBoot集成Swagger => springfox,两个jar包
使用Swagger
要求:jdk 1.8 + 否则swagger2无法运行
步骤:
-
新建一个SpringBoot-web项目
-
添加Maven依赖(注意:2.9.2版本之前,之后的不行)
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency>
-
编写HelloController,测试确保运行成功!
-
要使用Swagger,我们需要编写一个配置类-SwaggerConfig来配置 Swagger
@Configuration //配置类 @EnableSwagger2// 开启Swagger2的自动配置 public class SwaggerConfig { }
-
访问测试 :http://localhost:8080/swagger-ui.html ,可以看到swagger的界面; 最上面叫组
配置Swagger
-
Swagger实例Bean是Docket,所以通过配置Docket实例来配置Swaggger。
@Bean //配置docket以配置Swagger具体参数 public Docket docket() { //配置了swagger的Docket的bean实例 return new Docket(DocumentationType.SWAGGER_2); }
-
可以通过apiInfo()属性配置文档信息
//配置swagger文档信息 private ApiInfo apiInfo() { Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱"); return new ApiInfo( "Swagger学习", // 标题 "学习演示如何配置Swagger", // 描述 "v1.0", // 版本 "http://terms.service.url/组织链接", // 组织链接 contact, // 联系人信息 "Apach 2.0 许可", // 许可 "许可链接", // 许可连接 new ArrayList<>()// 扩展 ); }
-
Docket 实例关联上 apiInfo()
@Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()); }
-
重启项目,访问测试 http://localhost:8080/swagger-ui.html 看下效果;
配置扫描接口
-
构建Docket时通过select()方法配置怎么扫描接口。
自己
@Bean public Docket docket(){ return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() //RequestHandlerSelectors配置要扫描接口的方式 哪些参数 //basePackage指定要扫描的包 经常用 //any():扫描全部 //none():都不扫描 //withClassAnnotation():扫描类上的注解,参数是一个注解的反射对象 //withMethodAnnotation():扫描方法上的注解 .apis(RequestHandlerSelectors.basePackage("com.lt.controller")) //paths() :过滤什么路径 只扫描带有lt请求的接口 .paths(PathSelectors.ant("/lt/**")) .build(); }
@Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口 .apis(RequestHandlerSelectors.basePackage("nuc.ss.swagger.controller")) .build(); }
-
重启项目测试,由于我们配置根据包的路径扫描接口,所以我们只能看到一个类
-
除了通过包路径配置扫描接口外,还可以通过配置其他方式扫描接口,这里注释一下所有的配置方式:
basePackage(final String basePackage) // 根据包路径扫描接口 any() // 扫描所有,项目中的所有接口都会被扫描到 none() // 不扫描接口 // 通过方法上的注解扫描,如withMethodAnnotation(GetMapping.class)只扫描get请求 withMethodAnnotation(final Class<? extends Annotation> annotation) // 通过类上的注解扫描,如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口 withClassAnnotation(final Class<? extends Annotation> annotation)
-
除此之外,我们还可以配置接口扫描过滤:
@Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller")) // 配置如何通过path过滤,即这里只扫描请求以/ss开头的接口 .paths(PathSelectors.ant("/ss/**")) .build(); }
-
这里的可选值还有
any() // 任何请求都扫描 none() // 任何请求都不扫描 regex(final String pathRegex) // 通过正则表达式控制 ant(final String antPattern) // 通过ant()控制
配置Swagger开关
-
通过enable()方法配置是否启用swagger,如果是false,swagger将不能在浏览器中访问了
@Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .enable(false) //配置是否启用Swagger,如果是false,在浏览器将无法访问 .select() .apis(RequestHandlerSelectors.basePackage("com.lt.controller")) .paths(PathSelectors.ant("/ss/**")) .build(); }
我只希望我的swagger在生产环境中使用,在发布的时候不使用
- 判断是不是生产环境 flage=false
- 注入enable(flage)
指定使用那个配置文件
dev是生产环境使用swagger 8081
pro是发布环境不使用swagger 端口8082
-
如何动态配置当项目处于test、dev环境时显示swagger,处于prod时不显示?
@Bean public Docket docket(Environment environment) { // 设置要显示swagger的环境 Profiles of = Profiles.of("dev", "test");//表示dev环境和test环境才会显示swagger // 判断当前是否处于该环境 // 通过 enable() 接收此参数判断是否要显示 environment.acceptsProfiles 判断自己是否处在设定的环境中 boolean flage = environment.acceptsProfiles(of); return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .enable(flage) .select() .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller")) .paths(PathSelectors.ant("/ss/**")) .build(); }
-
可以在项目中增加dev配置文件
-
dev测试环境
server.port=8081
pro环境
server.port=8082
现在指定的是dev
-
项目运行结果
指定环境是pro
项目运行结果
配置API分组
-
如果没有配置分组,默认是default。通过groupName()方法即可配置分组:
@Bean public Docket docket(Environment environment) { return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()) .groupName("lt") // 配置分组 // 省略配置.... }
-
重启项目查看分组
-
如何配置多个分组?配置多个分组只需要配置多个docket即可:
@Bean public Docket docket1(){ return new Docket(DocumentationType.SWAGGER_2).groupName("group1"); } @Bean public Docket docket2(){ return new Docket(DocumentationType.SWAGGER_2).groupName("group2"); } @Bean public Docket docket3(){ return new Docket(DocumentationType.SWAGGER_2).groupName("group3"); }
重启项目查看即可实体配置
@ApiModel("用户实体") //这里也可以使用@Api
public class User {
@ApiModelProperty("用户名")
public String username;
@ApiModelProperty("密码")
public String password;
}
2、只要这个实体在请求接口的返回值上(即使是泛型),都能映射到实体项中:
@RequestMapping("/getUser")
public User getUser(){
//只要我们接口中,返回值存在实体类,他就会被扫描到swagger中
return new User();
}
重启查看测试
注:并不是因为@ApiModel这个注解让实体显示在这里了,而是只要出现在接口方法的返回值上的实体都会显示在这里,而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。
- @ApiModel为类添加注释
- @ApiModelProperty为类属性添加注释
总结:
- 我们可以通过Swagger给一些比较难理解的接口或者属性,增加注释信息
- 接口文档实时更新
- 可以在线测试
Swagger是一个优秀的工具,几乎所有大公司都有使用它
【注意点】:在正式发布的时候,关闭Swagger!!!
- 出于安全考虑
- 而且节省内存
常用注解
Swagger的所有注解定义在io.swagger.annotations包下
下面列一些经常用到的,未列举出来的可以另行查阅说明:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-MbMhe1V8-1598939880397)(SpringBoot.assets/1598145463258.png)]
我们也可以给请求的接口配置一些注释
-
在HelloController控制类中的接口添加api接口注释
@RestController public class HelloController { ...... @ApiOperation("Hello控制接口") @GetMapping("/hello") public String hello2(@ApiParam("用户名") String username) { return "hello" + username; } @ApiOperation("get测试") @GetMapping("/get") public User hello2(@ApiParam("用户") User user) { return user; } }
进行try it out测试
总结:
- 这样的话,可以给一些比较难理解的属性或者接口,增加一些配置注释信息,让人更容易阅读!
- 接口文档实时更新
- 可以在线测试
- 相较于传统的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>