一分钟完成springboot项目整合swagger2实现自动生成接口文档

author author     2023-03-01     388

关键词:

参考技术A 一份好的接口文档能够让接口调用者很清晰的知道如何调用一个API接口,包括请求方式、传参规范、接口返回信息等;也能帮助团队新人快速了解业务。

传统的做法是由开发人员维护一个API接口文档,一般是一个word文档或一个提供接口文档管理的网站。这种做法有很多弊端:文档难以维护、浪费开人员时间、文档难以与接口保持一致等。

Swagger2的出现很好的解决了上述问题,可以实现接口文档实时在线生成,提供在线接口测试功能。唯一的弊端就是对接口程序有侵入,但本人认为还是利大于弊的。

接下来我们将Swagger2整合到springboot项目中,并用swagger-bootstrap-ui对Swagger2进行界面美化,废话不多说,我们开始。。。

在pom.xml中导入

在application.yml中设置swagger2是否开启的开关,关闭后接口文档被关闭,在生产环境部署时就需要关闭接口文档。

1.创建注解SwaggerCustomIgnore.java,主要用于忽略某些不想生成接口文档的接口。

2.创建配置类SpringfoxSwagger2Config.java,配置Swagger接口文档生成规则和过滤规则。

3.拦截器排除swagger相关资源,新建或修改WebConfig.java文件,内容如下。

1.编写内容参考如下

2.注解说明

启动项目,浏览器输入http://location:8081/doc.html,效果如下。

基于springboot的完成ssm整合项目开发案例(代码片段)

SpringBoot🍌掌握基于SpringBoot框架的程序开发步骤🍌使用SpringBoot配置信息修改服务器配置🍌SpringBoot完成SSM整合之SpringBoot整合junit🍌基于SpringBoot的完成mybatis整合今日目标:基于SpringBoot的完成SSM整合项目开发案... 查看详情

上手springboot项目之springboot整合shiro安全框架

题记:在学习了springboot和thymeleaf之后,想完成一个项目练练手,于是使用springboot+mybatis和thymeleaf完成一个博客系统,在完成的过程中出现的一些问题,将这些问题记录下来,作为自己的学习心得。在这先感谢群主TyCoding的Tumo项... 查看详情

springboot2.0之四简单整合mybatis

...bernate),到后来的SMM(SpringMVC+Spring+MyBatis),到目前的S(SpringBoot),随着框架的不断更新换代,也为我们广大的程序猿提供了更多的方便,一起搭建一个从控制层到持久层的项目可能需要一两天的时间,但是采用SpringBoot的方式,... 查看详情

springboot完成ssm整合之springboot整合junit(代码片段)

SpringBoot🍌掌握基于SpringBoot框架的程序开发步骤🍌使用SpringBoot配置信息修改服务器配置今日目标:基于SpringBoot的完成SSM整合项目开发第一步一、SpringBoot整合junit回顾Spring整合junit@RunWith(SpringJUnit4ClassRunner.class)@C... 查看详情

springboot(代码片段)

文章目录学习目标一、SpringBoot简介1.入门案例问题导入1.1入门案例开发步骤1.2基于SpringBoot官网创建项目1.3SpringBoot项目快速启动2.SpringBoot概述问题导入2.1起步依赖2.2辅助功能二、基础配置1.配置文件格式问题导入1.0初始环境1.1修... 查看详情

idea新建一个springboot项目

...mvc)然后下一步、下一步即可创建完成。创建完成后,等springboot导入maven依赖。启动main函数,在idea的控制台没有看到错误日志,访问http://localhost:8080/至此一个SpringBoot项目就创建完成。 查看详情

5分钟springboot极速整合jwt生成token,一篇文章带你快速了解原理并使用(代码片段)

SpringBoot整合jwt登录功能的实现实现原理Session、Cookie、Token的使用状况实践测试生成Token给客户端pojoJwtUtilController解决跨域问题Vue验证客户端存储Tokenrouter.jsError.vueJwtUtil.javaUserController.java运行效果专业解读登录功能的实现登陆页面... 查看详情

springboot整合mybitas怎么配置oracle?

...入mybatis依赖。引入mysql驱动。项目pom.xml一览。这样完成springboot整合mybitas配置oracle。参考技术A身份认证框架,Shiro,实现用户、角色、身份认证常用功能。DB连接池:Druid,可实现大数据的快速查询和分析,性能很优秀。持久层框... 查看详情

springboot整合mongodb

...自己大概整理了下,项目中的相关配置就不叙述了,由于springboot的快捷开发方式,所以springboot项目中要使用Mongodb,只需要添加依赖和配置application.properties文件即可。整和方式一共有两种,一种是JPA的快捷方式,还有一种是实... 查看详情

springboot与dubbo整合入门(三种方式)(代码片段)

Springboot与Dubbo整合三种方式详解整合环境:jdk:8.0dubbo:2.6.2springboot:2.1.5项目结构:1、搭建项目环境:  (1)创建父项目与三个子项目,创建项目时,都使用springinitializr,创建时,父项目中注意的一点:    (2)创建三个子... 查看详情

十分钟完成springboot生产环境搭建代码仓库安装自动打包部署(代码片段)

文章以Springboot官方的HelloWorld项目为例,教你掌握Springboot项目生产环境搭建、持续集成环境搭建。通过此教程,你将获得:Gitlab代码托管环境GitlabCI/CD环境Springboot生产环境Springboot项目自动打包部署环境整个过程采用CS... 查看详情

项目实战----简单整合springboot+mybatis+themyleaf小项目(代码片段)

简单整合SpringBoot+MyBatis+Themyleaf小项目一、项目环境搭建①二、数据库表设计及项目环境②三、图片验证码功能四、用户注册功能五、用户登录功能六、员工的查询所有七、员工添加功能八、员工修改功能九、常见Git命令十... 查看详情

springboot整合mybatis非注解版

接上文:SpringBoot整合Mybatis【注解版】一、项目创建新建一个工程?选择SpringInitializr,配置JDK版本?输入项目名? 选择构建web项目所需的staters(启动器)?选择与数据库相关的组件?分析:SpringBoot基本上将我们实际项目开发中所... 查看详情

springboot整合shiro一:搭建环境

...pringSecurity如何选择我这里选择使用Shiro 环境搭建创建SpringBoot项目导入Maven依赖<dependency><groupId>org.springframework.boot</groupId&g 查看详情

springboot入门基础:介绍

一.SpringBoot初级(一)SpringBoot入门SpringBoot简介构件SpringBoot项目以及启动器讲解SpringBoot入门HelloWorld(二)SpringBoot整合Web开发整合Servlet整合Filter整合Listener访问静态资源文件上传(三)SpringBoot视图层技术整合jsp技术整合freemarker... 查看详情

基于springboot的完成mybatis整合(代码片段)

SpringBoot🍌掌握基于SpringBoot框架的程序开发步骤🍌使用SpringBoot配置信息修改服务器配置🍌SpringBoot完成SSM整合之SpringBoot整合junit今日目标:基于SpringBoot的完成mybatis整合一、SpringBoot整合mybatis1.1回顾Spring整合MybatisS... 查看详情

一分钟快速搭建springboot项目(代码片段)

大家好,我是二哥呀!学Java,自然少不了SpringBoot的学习!作为一名Java技术博主,已经被催了N多次SpringBoot的教程了,再不更新真有点鸽的不成样子——鸽上加鸽。因此我打算在接下来一段时间里间歇性地... 查看详情

springboot整合web开发

一,整合Servlet1,通过注解扫描完成Servlet组件的注册1.1编写servlet1/**2*3*springboot整合servlet方式一4*@authorjava5*<servlet>6*<servlet-name>FirstServletController</servlet-name>7*<servlet-class>com.zzp 查看详情