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

总结

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

相关文章

  • java instanceof操作符使用及原理解析

    java instanceof操作符使用及原理解析

    这篇文章主要介绍了java instanceof操作符使用及原理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-12-12
  • @MapperScan和@ComponentScan一块使用导致冲突的解决

    @MapperScan和@ComponentScan一块使用导致冲突的解决

    这篇文章主要介绍了@MapperScan和@ComponentScan一块使用导致冲突的解决,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • maven项目下solr和spring的整合配置详解

    maven项目下solr和spring的整合配置详解

    这篇文章主要介绍了maven项目下solr和spring的整合配置详解,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-11-11
  • Java检测线程中断状态的方法示例

    Java检测线程中断状态的方法示例

    这篇文章主要介绍了Java检测线程中断状态的方法,结合实例形式分析了java针对线程中断状态检测的相关实现技巧,需要的朋友可以参考下
    2019-10-10
  • 将java项目打包成exe可执行文件的完整步骤

    将java项目打包成exe可执行文件的完整步骤

    最近项目要求,需要将java项目生成exe文件,下面这篇文章主要给大家介绍了关于如何将java项目打包成exe可执行文件的相关资料,文章通过图文介绍的非常详细,需要的朋友可以参考下
    2022-06-06
  • Java求两集合的交集、并集、差集实例

    Java求两集合的交集、并集、差集实例

    这篇文章主要介绍了Java求两集合的交集、并集、差集实例,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-08-08
  • 浅析SpringBoot中常见的底层注解

    浅析SpringBoot中常见的底层注解

    Spring Boot 是一个用于创建独立的、基于Spring框架的Java应用程序的框架,它提供了许多注解,下面小编就来和大家介绍一些常见的底层注解吧
    2023-08-08
  • 关于kafka发送消息的三种方式总结

    关于kafka发送消息的三种方式总结

    这篇文章主要介绍了关于kafka发送消息的三种方式总结,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-04-04
  • Sentinel源码解析入口类和SlotChain构建过程详解

    Sentinel源码解析入口类和SlotChain构建过程详解

    这篇文章主要为大家介绍了Sentinel源码解析入口类和SlotChain构建过程详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-09-09
  • FeignClient如何脱离eureka自定义URL

    FeignClient如何脱离eureka自定义URL

    这篇文章主要介绍了FeignClient如何脱离eureka自定义URL,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06

最新评论