springboot3.x集成SpringDoc Swagger3过程

 更新时间:2026年01月04日 08:37:52   作者:咚咚阳丶  
文章介绍了如何将Spring Boot 2.x升级到3.x并同步升级Swagger 2到Swagger 3,包括添加Maven依赖、编写SpringDoc配置类、添加Swagger 3注解、自定义过滤器防止未授权访问等步骤

近期将springboox2.x升级到了3.x,索性将swagger2也同步升级到swagger3,具体过程如下。

一、添加maven依赖

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.1.0</version>
</dependency>

二、编写SpringDoc配置类

/**
 * spring doc配置
 */
@Configuration
public class SpringDocConfig {
    @Bean
    public OpenAPI restfulOpenAPI() {
        return new OpenAPI()
                .info(new Info().title("springboot3.x demo")
                        .description("Spring Boot3 Restful API")
                        .version("V1.0.0")
                        .license(new License().name("访问SpringDoc官方网站").url("http://springdoc.org")))
                .externalDocs(new ExternalDocumentation()
                        .description("欢迎访问LDY的技术博客")
                        .url("https://blog.csdn.net/ldy1016"));
    }

}

启动项目,在浏览器输入{ip}:{端口}/swagger-ui/index.html,查看效果,如127.0.0.1:8080/swagger-ui/index.html

三、添加swagger3注解

首先来看一下swagger2和swagger3中注解的对应关系,方便使用swagger2的同学升级到swagger3

swagger2swagger3说明
@Api@Tag用在请求的类上,表示对类的说明
@ApiIgnore@Hidden隐藏显示
@ApiImplicitParam@Parameter用在请求方法上,指定具体某一个请求参数的详细信息
@ApiImplicitParams@Parameters用在请求方法上,表示一组参数的说明
@ApiModel@Schema用于请求或者响应类上,说明请求或者响应数据
@ApiModelProperty@Schema用在属性上,描述响应类的属性用,swagger2中的hidden = true属性相当于swagger3中 的accessMode = READ_ONLY属性
@ApiOperation@Operation用在请求的方法上,说明方法的用途、作用,对应注解中swagger2中的value和notes属性对应swagger3中的summary和description属性
@ApiParam@Parameter描述参数信息

参考示例:

@Tag 描述整个类

@Tag(name = "用户管理")
@RestController
@RequestMapping("/user")
public class UserController {}

@Operation 用在请求的方法上,说明方法的用途、作用

    @Operation(summary = "查询用户列表接口",description = "部门用户信息")
    @GetMapping("/list")
    public List<UserVO> list(@RequestBody UserQueryParam param) {

        //TODO 查询用户信息并返回

        return null;
    }

@Schema 用于请求或者响应类上,说明请求或者响应数据,用在属性上,描述响应类的属性用

@Data
@Schema(title = "用户信息查询参数")
public class UserQueryParam implements Serializable {
    private static final long serialVersionUID = 4159622041608936674L;

    @Schema(title = "部门")
    private String department;

    @Schema(title = "姓名")
    private String name;

    @Schema(title = "性别",allowableValues = "0,1",example = "0")
    private Integer sex;

}

打开swagger页面查看效果

四、自定义过滤器,防止swagger文档未授权访问

swagger3未授权访问的路径主要包括/v3/api-docs/swagger-ui/index.html

本人提供的解决方案就是通过过滤器的方式对请求进行验证,请求的时候需要在链接后面加上我们自定义的token参数,通过验证token判断是否是合法的访问,注意,添加过滤器后需要在启动类上加上

@ServletComponentScan注解才能生效,具体实现如下:

import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.FilterConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.annotation.WebFilter;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;

/**
 * 解决swagger-ui 未授权访问漏洞,需要在启动类加@ServletComponentScan注解
 * 
 * @author ldy
 * @since V1.0.0
 */
@Slf4j
@WebFilter(urlPatterns = {"/v3/api-docs",
        "/swagger-ui/index.html"}, filterName = "springDocFilter")
public class SpringDocFilter implements Filter {

    /**
     * 访问swagger的token
     */
    @Value("${swagger.token:123@abc}")
    private String swaggerToken;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Filter.super.init(filterConfig);
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
            throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;
        log.info("do springDocFilter,url:{}", request.getRequestURL());
        // 请求来源地址
        String referer = request.getHeader("referer");
        log.info("referer is {}", referer);

        /**
         * 1、请求来源地址为空,判断token是否匹配 2、请求来源地址不为空,判断来源地址是否包含正确的token
         */
        if (StringUtils.isBlank(referer)) {
            // 获取token
            String token = request.getParameter("token");
            log.info("token is {}", token);
            // 来源地址为空,判断token是否匹配
            if (!StringUtils.equals(swaggerToken, token)) {
                log.error("禁止未授权访问,url:{}", request.getRequestURL());
                response.setStatus(403);
                servletResponse.setContentType("application/json");
                servletResponse.setCharacterEncoding("UTF-8");
                servletResponse.getWriter().write(JsonUtil.toJsonString(DJResult.error(-1, "禁止未授权访问", "")));
                return;
            }
        } else if (!referer.contains(swaggerToken)) {
            log.warn("禁止未授权访问,url:{}", request.getRequestURL());
            response.setStatus(403);
            servletResponse.setContentType("application/json");
            servletResponse.setCharacterEncoding("UTF-8");
            servletResponse.getWriter().write(JsonUtil.toJsonString(DJResult.error(-1, "禁止未授权访问", "")));
            return;
        }


        filterChain.doFilter(servletRequest, servletResponse);
    }

    @Override
    public void destroy() {
        Filter.super.destroy();
    }
}

通过添加如上所示的过滤器后,我们就可以通过在路径后面加上token参数进行访问文档地址了,如:127.0.0.1:8080/swagger-ui/index.html?token=123@abc

没有加token参数或者token参数匹配不上的请求会直接返回“禁止未授权访问”。

这里的token尽量设置复杂一点。

总结

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

相关文章

  • Spring案例打印机的实现过程详解

    Spring案例打印机的实现过程详解

    这篇文章主要介绍了Spring案例打印机的实现过程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-10-10
  • SpringBoot整合Caffeine使用示例

    SpringBoot整合Caffeine使用示例

    Spring Boot 和 Caffeine 可以很容易地进行整合,Caffeine 是一个现代化的 Java 缓存库,提供了高性能和灵活的缓存策略,本文给大家介绍了SpringBoot整合Caffeine使用示例,需要的朋友可以参考下
    2024-07-07
  • jdbc和mybatis的流式查询使用方法

    jdbc和mybatis的流式查询使用方法

    有些时候我们所需要查询的数据量比较大,但是jvm内存又是有限制的,数据量过大会导致内存溢出。这个时候就可以使用流式查询,本文就主要介绍了jdbc和mybatis的流式查询,感兴趣的可以了解一下
    2021-11-11
  • 详解Spring Boot使用redis实现数据缓存

    详解Spring Boot使用redis实现数据缓存

    本篇文章主要介绍了详解Spring Boot使用redis实现数据缓存,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-04-04
  • Java的NIO之通道channel详解

    Java的NIO之通道channel详解

    这篇文章主要介绍了Java的NIO之通道channel详解,通道channel由java.nio.channels 包定义的,Channel 表示IO源与目标打开的连接,Channel类类似于传统的"流",只不过Channel本身不能直接访问数据,Channel只能与Buffer进行交互,需要的朋友可以参考下
    2023-10-10
  • JSP、Servlet中get请求和post请求的区别总结

    JSP、Servlet中get请求和post请求的区别总结

    这篇文章主要介绍了JSP、Servlet中get请求和post请求的区别总结,列举了多条不同点,需要的朋友可以参考下
    2014-07-07
  • java对接Modbus协议代码示例

    java对接Modbus协议代码示例

    Modbus是一种串行通信协议,Modbus已经成为工业领域通信协议的业界标准,并且现在是工业电子设备之间常用的连接方式,这篇文章主要给大家介绍了关于java对接Modbus协议的相关资料,需要的朋友可以参考下
    2024-03-03
  • Java Map简介_动力节点Java学院整理

    Java Map简介_动力节点Java学院整理

    Map 接口提供三种collection 视图,允许以键集、值集或键-值映射关系集的形式查看某个映射的内容。本文是动力节点java学院给大家整理的java map知识,需要的的朋友参考下吧
    2017-05-05
  • springboot自定义日志注解的实现

    springboot自定义日志注解的实现

    本文主要介绍了springboot自定义日志注解的实现,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-03-03
  • nacos未自动注册问题及解决

    nacos未自动注册问题及解决

    文章主要介绍了在使用Nacos服务发现时遇到的问题,通过查阅资料和文档,发现服务自动注册的特性是Spring Cloud Alibaba 0.2.3版本才有的功能,作者从使用0.2.1版本到升级到0.2.3版本,问题得以解决
    2025-10-10

最新评论