swagger-ui.html渲染出错:Please indicate a valid Swagger or OpenAPI version field

一、错误环境

        在微服务框架中集成SpringDoc(2.0.2),并对接口返回值进行统一封装。具体环境配置如下:

  • spring boot:3.0.0版本
  • spring cloud:2022.0.0版本
  • spring cloud alibaba:2022.0.0.0-RC1版本
  • springdoc:2.0.2版本
  • fastjson2:2.0.22版本
  • 在项目的主pom文件中引入如下依赖包
<dependency>
	<groupId>org.springdoc</groupId>
	<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
	<version>2.0.2</version>
</dependency>
<dependency>
	<groupId>org.springdoc</groupId>
	<artifactId>springdoc-openapi-starter-webflux-ui</artifactId>
	<version>2.0.2</version>
</dependency>

二、错误截图

        启动服务后访问swagger主页(http://localhost:8080/swagger-ui.html)报错,错误截图如下:
错误截图

三、错误原因场景分析

1、场景一:Controller层中含有私有方法(private方法)

        请自行查看项目工程中所有的controller层是否包含私有方法,如果存在私有方法请将私有方法移动到service或serviceimpl层中即可解决该场景。

2、场景二:同一Controller层中同一请求类型包含多个相同请求路径

        请自行查看项目工程中所有的controller层,看同一Controller层中同一请求类型包含多个相同请求路径,示例代码如下:
示例代码
        如果存在,请自行改成不同的请求路径即可解决该场景。

3、场景三:传入参数模型带有异常符号

        在DTO对象中写API属性注解的示例参数时,example中带有特殊符号,比如多写了些省略符号,如下截图所示:
特殊符号错误
        如果存在,请自行检查并去掉特殊符号或按照springdoc的语法规则编写example即可解决该场景。

4、场景四:swagger自带接口的返回值结构不正确

        该场景主要是项目中对所有接口的返回值进行统一封装,但是没有排除swagger自带接口(路径中包含api-docs),只需要在所有接口的返回值进行统一封装的类里面排除swagger自带接口(及对swagger自带接口返回值不做统一封装)即可解决该场景。比如做如下修改:
代码修改
        修改后,重启服务,再次访问swagger主页(http://localhost:8080/swagger-ui.html)即可正常访问。如下所示:
正常访问swagger
        swagger自带接口(路径中包含api-docs)正常返回值结构,如下所示:
正常返回值结构
        swagger自带接口(路径中包含api-docs)异常返回值结构,如下所示:
异常返回值结构

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

giser@2011

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值