springboot如何集成Swagger2
一、是什么
当下很多公司都采取前后端分离的开发模式,前端和后端的工作由不同的工程师完成。在这种开发模式下,维持一份及时更新且完整的 rest api 文档将会极大的提高我们的工作效率。传统意义上的文档都是后端开发人员手动编写的,相信大家也都知道这种方式很难保证文档的及时性,这种文档久而久之也就会失去其参考意义,反而还会加大我们的沟通成本。而 swagger 给我们提供了一个全新的维护 api 文档的方式。
二、为什么要使用它
1、代码变更,文档跟着代码变、只需要少量的注解swagger就可以根据代码自动的生成api文档,很好的保证了文档的实时性。
2、跨语言,swagger支持40多种语言。
3、swagger ui 呈现出来的是一份可以交互的api文档,我们可以直接在文档页面尝试api的调用,省去了准备复杂的调用参数的过程。
4、还可以将文档规范导入相关的工具里面(例如:postman、soapui)、这些工具将会为我们自动地创建自动化测试。
三、怎么用
1、在项目pom.xml里面加入swagger2相关的依赖
<!--swagger2配置--> <dependency> <groupid>io.springfox</groupid> <artifactid>springfox-swagger-ui</artifactid> <version>2.4.0</version> </dependency> <dependency> <groupid>io.springfox</groupid> <artifactid>springfox-swagger2</artifactid> <version>2.4.0</version> </dependency> <dependency> <groupid>com.github.xiaoymin</groupid> <artifactid>swagger-bootstrap-ui</artifactid> <version>1.6</version> </dependency>
2、新建swagger2的配置类
package com.zhouhong.config; import org.springframework.context.annotation.bean; import org.springframework.context.annotation.configuration; import springfox.documentation.builders.apiinfobuilder; import springfox.documentation.builders.pathselectors; import springfox.documentation.builders.requesthandlerselectors; import springfox.documentation.service.apiinfo; import springfox.documentation.service.contact; import springfox.documentation.spi.documentationtype; import springfox.documentation.spring.web.plugins.docket; import springfox.documentation.swagger2.annotations.enableswagger2; /** * @classname: swagger2 * @description: * @author: 周红 * @nickname: tom-shuhu * @date: created in 2020/12/15 **/ @configuration @enableswagger2 public class swagger2 { // http://localhost:8088/swagger-ui.html 原路径 // http://localhost:8088/doc.html 原路径 //配置swagger2核心配置 @bean public docket createrestapi(){ return new docket(documentationtype.swagger_2) //指定api类型位swagger2 .apiinfo(apiinfo()) //用于定义api文档汇总信息 .select().apis(requesthandlerselectors .basepackage("com.zhouhong.controller")) //指定生成文档的controller .paths(pathselectors.any()) .build(); } private apiinfo apiinfo(){ return new apiinfobuilder() .title("tom-shushu 的项目接口api") //文档标题 .contact(new contact("周红", //作者 "www.zhouhong.icu", "15249239025@163.com")) //联系人 .description("tom-shushu 的项目api接口")//详细信息 .version("1.0.0")//文档版本号 .termsofserviceurl("www.zhouhong.icu")//网站地址 .build(); } }
文档配置说明:
a.为任何接口生成api文档,这种方式不必在接口方法上加任何注解,方便的同时也会因为没有添加任何注解所以生成的api文档也没有注释,可读性不高。
@bean public docket createrestapi(){ return new docket(documentationtype.swagger_2) .apiinfo(apiinfo()) .select() //为任何接口生成api文档 .apis(requesthandlerselectors.any()) .paths(pathselectors.any()) .build(); }
b.为当前配置的包下controller生成api文档
.apis(requesthandlerselectors.basepackage("com.troila"))
c.为有@api注解的controller生成api文档
.apis(requesthandlerselectors.withclassannotation(api.class))
d.为有@apioperation注解的方法生成api文档
.apis(requesthandlerselectors.withmethodannotation(apioperation.class))
三、常见注解简介
@api:修饰整个类,描述controller的作用 @apioperation:描述一个类的一个方法,或者说一个接口 @apiparam:单个参数描述 @apimodel:用对象实体来作为入参 @apiproperty:用对象接实体收参数时,描述对象的一个字段 @apiresponse:http响应其中1个描述 @apiresponses:http响应整体描述 @apiignore:使用该注解忽略这个api @apierror :发生错误返回的信息 @apiimplicitparam:一个请求参数 @apiimplicitparams: 多个请求参数
四、演示(为方便我使用了上面第一种配置)
1、使用原路径访问
2、原路径调试
3、doc模式访问
4、doc模式调试
以上就是springboot集成swagger2的详细内容,更多关于springboot集成swagger2的资料请关注其它相关文章!
上一篇: pr怎么制作垂直字幕从左往右滚动?
下一篇: 哈啰出行如何申请注销账号?