七叶笔记 » java编程 » springBoot详解集成Swagger流程

springBoot详解集成Swagger流程

目标:

了解Swagger的作用和概念了解前后端分离在springBoot中集成Swagger

Swagger简介

前后端分离

VUE+springBoot

后端 :后端控制层、服务层、数据访问层前端 :前端控制层、视图层前后端通过API进行交互前后端相对独立,松耦合可以部署在不同的服务器上

产生的问题

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

解决方案

首先定义计划的提纲,并实时跟踪最新的API,降低集成风险

Swagger

号称世界上最流行的API框架Restful Api 文档在线自动生成器 =>API 文档 与API 定义同步更新直接运行,可以在线测试API接口;支持多种语言 (如:Java,PHP等)官网:https://swagger.io/

SpringBoot集成Swagger

新建一个springboot-web项目

下载maven依赖https://mvnrepository.com/search?q=springfox

高版本是没有第5部的测试页面

3.0.0版本的要先在启动类中加上注解@EnableOpenApi先在导入<groupId>io.springfox</groupId><artifactId>springfox-boot-starter</artifactId>

编写Controller,测试运行成功

配置Swagger=》在包Config下

测试运行:http://localhost:8080/swagger-ui.html

配置Swagger

Swagger实例Bean是Docket,所以通过配置Docket实例来配置Swaggger。

再通过ApiInfo()属性配置文档信息

Docket关联上ApiInfo

启动项目,访问http://localhost:8080/swagger-ui.html

Swagger配置扫描接口

构建Docket时通过select()方法配置怎么扫描接口。select()和build()是一套的

我们看之前的运行结构可以看到有base-error-controller和hello-controller,一旦使用了上述配置后,运行结果只有hello-controller

配置是否启动Swagger

通过enable()方法配置是否启用swagger

Swagger在生产环境中使用,在发布的时候不使用

判断是否是生产环境注入enable()值

当我们有多个生产环境时。比如说application-dev.yaml和application-pro.yaml。动态设置当前项目处于dev时显示swagger,Pro是不显示

#哪个环境生效spring.profiles.active=dev

设置我们的dev走8081,默认走8080,pro走8082

然后修改我们的配置

此时我们就发现,如果我们走默认的8080是没有Swagger的,走8081才有

配置API文档的分组

启动项目就发现我们的组别有了

如果有多个分组怎么办?只需要配置多个docket即可

实体类配置

创建一个实体类

只要这个实体在请求接口的返回值上,就可以映射到实体项中

测试

此时发现我们的Model中有了User。如果有中文的注释,只需要在加两个注解

测试

常用的注解

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

注解在类上的可以看一下上面的,接下来看注解在接口方法上,以及参数上

在这里还可以进行测试

小结 我们可以通过Swagger给一些比较难理解的属性或者接口增加注释信息接口文档实时更新可以在线测试在正式发布的时候一定要关闭Swagger《安全;节省运行的内存》

到此这篇关于springBoot详解集成Swagger流程的文章就介绍到这了,更多相关springBoot Swagger内容请搜索七叶笔记以前的文章或继续浏览下面的相关文章希望大家以后多多支持七叶笔记!

相关文章