SpringBoot整合Swagger3.0全过程

 更新时间:2026年03月13日 15:07:14   作者:bug攻城狮  
文章介绍了Swagger3,一个自动生成接口文档的工具,相比Swagger2,配置更少,使用更方便,文章详细介绍了如何引入依赖,添加开关注解,访问Swagger界面,以及如何配置Swagger和引入第三方UI包来美化页面

一、引言

前后端分离的项目,接口文档的存在十分重要。与手动编写接口文档不同,swagger是一个自动生成接口文档的工具,只需要在pom文件中引入一个依赖包,然后在代码中通过注解的方式即可实现文档的编写,毕竟在需求不断变更的环境下,手动编写文档的效率实在太低且不够同步,swagger的出现,将文档和代码融合在一起,再也不需要写完代码后再去手动修改文档了。

二、简介

Swagger3在Swagger2的基础上进行了部分升级,与swagger2相比新版的swagger3配置更少,使用更加方便。

一个重要的优化是依赖的引入,由之前的多个依赖变更为一个依赖,跟随springboot-starter风格,同时引入了新的开关注解 @EnableOpenApi 以代替 @EnableSwagger2 。

因此,集成工作变得更加的简便了,必要工作只有两个,添加swagger3的starter依赖包,在springboot主启动类添加 @EnableOpenApi 开关注解。

三、快速入门

(一)引入依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

(二)主启动类添加开关注解 @EnableOpenApi

作用:表示开启生成接口文档功能,只有开启了OpenApi,才能实现生成接口文档的功能

@EnableOpenApi
@SpringBootApplication
public class SwaggerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SwaggerApplication.class, args);
    }
}

(三)访问Swagger界面

访问地址(默认端口号是8080):http://localhost:8080/swagger-ui/index.html

四、进阶使用

(一)配置Swagger

// 表明当前类是配置类
@Configuration
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                // 为api选择启动生成器
                .select()
                // 指定要生成api文档的根包
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                // 路径配置
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建一个ApiInfo对象
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 文档标题
                .title("SpringBoot整合Swagger3")
                // 简介
                .description("更多请咨询服务开发者小龍")
                // 作者信息:作者姓名、作者地址、作者邮箱
                .contact(new Contact("小龍", "https://blog.csdn.net/wangzhilong1996", "123456@qq.com"))
                // 版本号
                .version("1.0")
                .build();
    }
}

(二)引入第三方UI包

原生的ui页面并不美观,可以使用第三方的ui包来美化页面,当然,市面上的第三方ui包有很多,大家可以找一个自己喜欢的,不一定用我的。

<!-- swagger 第三方ui包 -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.6</version>
</dependency>

访问地址:http://localhost:8080/doc.html

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • struts2入门介绍及代码实例

    struts2入门介绍及代码实例

    这篇文章主要介绍了struts2入门介绍及代码实例,具有一定借鉴价值,需要的朋友可以参考下。
    2017-12-12
  • JavaEE Filter敏感词过滤的方法实例详解

    JavaEE Filter敏感词过滤的方法实例详解

    我们无论是在聊天还是在留言时,都有一些信息不希望别人看到。那么如果过滤这些关键词呢?下面小编给大家分享JavaEE Filter敏感词过滤的方法实例详解,感兴趣的朋友一起学习吧
    2016-05-05
  • log4j升级log4j2遇到的问题及解决方式

    log4j升级log4j2遇到的问题及解决方式

    这篇文章主要介绍了log4j升级log4j2遇到的问题及解决方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • Java中的可重入锁ReentrantLock简析

    Java中的可重入锁ReentrantLock简析

    这篇文章主要介绍了Java中的可重入锁ReentrantLock简析,可重入是指同一个线程如果首次获得了这把锁,那么因为它是这把锁的拥有者,因此有权利再次获取这把锁如果是不可重入锁,那么第二次获得锁时,自己也会被锁挡住,需要的朋友可以参考下
    2023-12-12
  • Java语言基于无向有权图实现克鲁斯卡尔算法代码示例

    Java语言基于无向有权图实现克鲁斯卡尔算法代码示例

    这篇文章主要介绍了Java语言基于无向有权图实现克鲁斯卡尔算法代码示例,具有一定参考价值,需要的朋友可以了解下。
    2017-11-11
  • Java并发编程之Semaphore(信号量)详解及实例

    Java并发编程之Semaphore(信号量)详解及实例

    这篇文章主要介绍了Java并发编程之Semaphore(信号量)详解及实例的相关资料,需要的朋友可以参考下
    2017-06-06
  • springboot中动态权限实时管理的实现详解

    springboot中动态权限实时管理的实现详解

    这篇文章主要为大家详细介绍了如何简单实现一个在springboot中动态权限的实时管理,文中的示例代码讲解详细,感兴趣的小伙伴可以了解一下
    2024-10-10
  • Spring-boot JMS 发送消息慢的解决方法

    Spring-boot JMS 发送消息慢的解决方法

    这篇文章主要为大家详细介绍了Spring-boot JMS 发送消息慢的解决方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-08-08
  • Spring boot 在idea中添加热部署插件的图文教程

    Spring boot 在idea中添加热部署插件的图文教程

    这篇文章主要介绍了Spring boot 在idea中添加热部署插件的图文教程,本文通过图文并茂的形式给大家展示具体步骤,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-10-10
  • ZooKeeper入门教程一简介与核心概念

    ZooKeeper入门教程一简介与核心概念

    本文是ZooKeeper入门系列教程,涵盖ZooKeeper核心内容,通过实例和大量图表,结合实战,帮助学习者理解和运用,有需要的朋友可以借鉴参考下,希望能够有所帮助
    2022-01-01

最新评论