SpringBoot整合Swagger接口文档工具的流程步骤

 更新时间:2023年08月18日 09:58:36   作者:Jimmy  
我们在开发接口的时候,会将接口文档给前端的开发者进行对接,我们可以通过Postman或者Yapi等接口管理工具进行编写管理,实际开发中,接口的管理确实也应该通过专业的工具管理,本文,我们就来谈谈怎么在SpringBoot整合Swagger接口文档工具

我们在开发接口的时候,会将接口文档给前端的开发者进行对接。我们可以通过 Postman或者 Yapi等接口管理工具进行编写管理。实际开发中,接口的管理确实也应该通过专业的工具管理。

那么,如果只是小团队使用,我们是否可以在边开发的过程中,顺便把接口文档给写了呢?

当然,本文,我们就来谈谈怎么在 Spring Boot整合 Swagger接口文档工具。

本文开发环境:

  • spring boot 版本 2.1.3.RELEASE
  • java SDK 版本 1.8
  • mac m1 系统

本文,在笔者之前的项目浅聊一下Spring Security的使用方法基础上开发。

笔者尝试了下整合 swagger3,但是因为原先项目版本的问题,未能整合成功。故整合 swagger2,文档作用都一样,就是页面长得不一样,可以放心使用。

添加依赖

我们在 pom.xml 中添加下面的依赖:

<!-- swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.6</version>
</dependency>

并在配置文件中添加配置:

spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER

引入配置

在包 com.launch.config 中添加 SwaggerConfig.java 类:

swagger_class.png

package com.launch.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;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.launch.controller")) // 接口所在的包
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Launch 系统") // 标题
                .description("Jimmy Control System") // 描述
                .version("1.0.0") // 版本
                // 姓名,联系 link,邮箱
                .contact(new Contact("Jimmy", "https://juejin.cn/user/1996368846261294", "reng99@outlook.com"))
                .build();
    }
}

到此,我们运行项目,打开连接 http://localhost:8080/swagger-ui/index.html ,咦, 404 耶~

404.png

处理 404

版本的问题,使得我们无法读取 swagger 包下面的页面。那么,我们来重写。

我们在 com.launch.config 中新增 WebMvcConfig.java 文件:

package com.launch.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
        registry.addResourceHandler("doc.html")
                .addResourceLocations("classpath:/META-INF/resources/");
    }
}

重新启动,访问路径 http://localhost:8080/doc.html ,就可以看到效果。

接口信息dashboard.png

在本文浅聊一下Spring Security的使用方法 中,我们已经开发好了六个接口。点击进入其中一个,比如 queryAll 查询所有用户的接口,可看到其文档:

接口文档.png

我们还可以对该接口进行调试:

调试.png

感兴趣的读者可以自行尝试。

以上就是SpringBoot整合Swagger接口文档工具的流程步骤的详细内容,更多关于SpringBoot整合Swagger的资料请关注脚本之家其它相关文章!

相关文章

  • 关于阿里巴巴TransmittableThreadLocal使用解读

    关于阿里巴巴TransmittableThreadLocal使用解读

    文章主要介绍了三种ThreadLocal的使用:ThreadLocal、InheritableThreadLocal和TransmittableThreadLocal,ThreadLocal和InheritableThreadLocal在单线程和部分情况下可以正常工作,但TransmittableThreadLocal在处理线程池时表现更佳
    2025-02-02
  • 详细解读Java的Lambda表达式

    详细解读Java的Lambda表达式

    这篇文章主要介绍了详细解读Java的Lambda表达式,lambda 表达式 是Java 8新加入的新特性,它在Java中是引入了函数式编程这一概念,需要的朋友可以参考下
    2023-04-04
  • Java基础之switch分支结构详解

    Java基础之switch分支结构详解

    这篇文章主要介绍了Java基础之switch分支结构详解,文中有非常详细的代码示例,对正在学习java的小伙伴们有很大的帮助,需要的朋友可以参考下
    2021-05-05
  • Spring AOP手动实现简单动态代理的代码

    Spring AOP手动实现简单动态代理的代码

    今天小编就为大家分享一篇关于Spring AOP手动实现简单动态代理的代码,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-03-03
  • Spring Boot 2.X快速整合jpa过程解析

    Spring Boot 2.X快速整合jpa过程解析

    这篇文章主要介绍了Spring Boot 2.X 如何快速整合jpa?,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-08-08
  • 基于Java编写一个限流工具类RateLimiter

    基于Java编写一个限流工具类RateLimiter

    这篇文章主要为大家详细介绍了如何基于Java编写一个限流工具类RateLimiter,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-01-01
  • java方法重写和super关键字实例详解

    java方法重写和super关键字实例详解

    这篇文章主要介绍了java方法重写和super关键字实例详解的相关资料,需要的朋友可以参考下
    2017-03-03
  • 引入QQ邮箱发送验证码进行安全校验功能实现

    引入QQ邮箱发送验证码进行安全校验功能实现

    最近遇到这样的需求用户输入自己的邮箱,点击获取验证码,后台会发送一封邮件到对应邮箱中,怎么实现呢?下面小编给大家带来了引入QQ邮箱发送验证码进行安全校验功能,需要的朋友可以参考下
    2023-02-02
  • java实现本地缓存的示例代码

    java实现本地缓存的示例代码

    在高性能服务架构设计中,缓存是不可或缺的环节,因此这篇文章主要为大家详细介绍了java中如何实现本地缓存,感兴趣的小伙伴可以了解一下
    2024-01-01
  • Java实现文字滚动广告字幕效果

    Java实现文字滚动广告字幕效果

    文字滚动广告字幕是一种常见的动态文本展示效果,通常用于展示新闻、广告或其他动态信息,在本项目中,我们将使用Java的Swing库来实现一个简单的文字滚动广告字幕效果,通过定时更新文本的位置来模拟文字的滚动,需要的朋友可以参考下
    2025-02-02

最新评论