admin管理员组文章数量:1550647
目录
- 一、错误环境
- 二、错误截图
- 三、错误原因场景分析
- 1、场景一：Controller层中含有私有方法（private方法）
- 2、场景二：同一Controller层中同一请求类型包含多个相同请求路径
- 3、场景三：传入参数模型带有异常符号
- 4、场景四：swagger自带接口的返回值结构不正确
一、错误环境
在微服务框架中集成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自带接口（路径中包含api-docs）正常返回值结构，如下所示：
swagger自带接口（路径中包含api-docs）异常返回值结构，如下所示：
本文标签： htmlValidswaggerUIVersion
版权声明：本文标题：swagger-ui.html渲染出错：Please indicate a valid Swagger or OpenAPI version field 内容由热心网友自发贡献，该文观点仅代表作者本人， 转载请联系作者并注明出处：https://m.elefans.com/dongtai/1727246410a1104679.html， 本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容，一经查实，本站将立刻删除。
发表评论