时间:2021-05-19
当下很多公司都采取前后端分离的开发模式,前端和后端的工作由不同的工程师完成。在这种开发模式下,维持一份及时更新且完整的 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@EnableSwagger2public 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("周红", //作者 ".troila"))c.为有@Api注解的Controller生成API文档
.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))d.为有@ApiOperation注解的方法生成API文档
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))1、使用原路径访问
2、原路径调试
3、doc模式访问
4、doc模式调试
以上就是springboot集成Swagger2的详细内容,更多关于springboot集成Swagger2的资料请关注其它相关文章!
声明:本页内容来源网络,仅供用户参考;我单位不保证亦不表示资料全面及准确无误,也不保证亦不表示这些资料为最新信息,如因任何原因,本网内容或者用户因倚赖本网内容造成任何损失或损害,我单位将不会负任何法律责任。如涉及版权问题,请提交至online#300.cn邮箱联系删除。
前言之前跟大家分享了SpringMVC集成springfox-swagger2构建restfulAPI,简单写了如何在springmvc中集成swagger2。
1.添加Swagger2依赖io.springfoxspringfox-swagger22.2.2io.springfoxspringfox-swagger-u
1.场景描述本节结合springboot2、springmvc、mybatis、swagger2等,搭建一个完整的增删改查项目,希望通过这个基础项目,能帮忙朋友
前言在集成springfox-swagger2之前,我也尝试着集成了swagger-springmvc,方式差不多,但是swagger-springmvc相对麻
swagger是一个功能强大的在线API文档的框架,提供了优雅的API在线文档的查阅和测试功能。利用swagger2可以很方便的构建RESTful风格的API文