swagger不显示controller接口问题的汇总

已于 2022-04-04 16:26:13 修改
阅读量2.4w 收藏 14
点赞数 12
分类专栏： swagger 文章标签： bug java
于 2022-04-04 16:25:30 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_45748157/article/details/123955382
版权

1.首先我们有一个swagger的配置类
在这里插入图片描述
注意下哦, 这里我是service-hospital引用了service-util

那么为什么会出现接口不显示的问题?

1.是不是在启动类文件上加了@ComponentScan(basePackage=“xxxswagger.config路径”)注解?!!!
非常关键 如果你加了那么springboot工程就不会扫你的Controller文件了
所以Controller就不会在容器里,更不会显示 ------->>>只用在swagger配置上加@Configuration就行了,springboot启动会加载@Configuration注解的
2.是不是Controller层没加 @Controller注解
3.是不是没加@EnableSwagger2注解?? 注意swagger配置文件加了,springboot启动文件就不用加了 ,因为启动项目不是引用了我这个service-util项目嘛

最后呢 附带上我的代码吧
在这里插入图片描述

若依新建模块后，swagger扫描不到新模块中的controller接口
猿小白的博客
07-03 6160
框架默认情况下，只能扫描ruoyi-admin模块下的controller接口。如果需要扫描其它子模块中的swagger注解，那么需要调整一下swagger相关内容。
百度百度白百度 Swagger配置Model但接口不显示描述信息的，响应参数名称不同Java
TechRoar的博客
09-03 999
通过正确配置Swagger的注解和附加的配置，我们可以确保生成的API文档中能够正确显示Model的描述信息和参数名称。在使用Swagger进行API文档生成时，有时候可能会遇到以下问题：配置了Swagger的Model，但是在生成的API文档中，接口没有显示描述信息，而且响应参数的名称与预期不符。然而，有时候即使正确配置了Model的注解，Swagger仍然无法正确显示描述信息和参数名称。这些配置可以帮助Swagger正确扫描到Model的注解，并将其显示在生成的API文档中。在上述配置中，我们添加了。
swagger没有扫描到controller
zzqtty的博客
08-24 2056
配置swagger后，没有显示出controller，配置都加了。
Swagger2 或者Swagger3 的Knife4jConfig 配置,父子项目swagger扫描多个子模块中的Controller生成接口文档:
最新发布
tiger_Angle
02-13 1047
Swagger2Knife4jConfig 配置放在了 springboot-app 启动项目里，而 tiger-web 和 tiger-web2 这两个子项目有自己的 Controller。如果 tiger-web 和 tiger-web2 是 独立的服务，建议 方案 2，每个模块独立配置 Swagger。这样，springboot-app 启动后，Swagger 也能扫描 tiger-web 和 tiger-web2 里的 Controller 了。
swagger不显示controller接口问题的解决
weixin_42821448的博客
08-15 6022
如上图所示的swagger页面不显示下面的部分，项目可以正常运行，没有报错。 解决办法： swagger的服务调用中common中 的swagger配置类所在的包路径必须和调用swagger的controller的路径名相同，比如com.example和com.example.demo.controller swagger的所在包必须和controller平级或者是controller的父级 如图，此处的包名必须和引用它的项目的包名一致 ...
集成Swagger2，接口文档不显示
strggle_bin的博客
01-24 3107
swagger的首页可以显示，就是不显示接口。配置类上添加：@EnableWebMvc。
swagger2启动找不到接口，提示No operations defined in spec!
荒野拖拉机
06-12 1488
4.检查配置都没有问题，确定启动类和controller对应位置正确。5.以上都正确，但是找不到接口，可以在配置文件中添加以下配置。2.如果使用指定扫描包位置方式，指定接口，确保包的位置正确。3.如果使用指定注解的方式，确认接口上添加对应注解。1.首先检查配置文件是否正确，网上示例很多。问题解决，check！
Swagger不显示接口注释
标准都是留给不爱的人，爱的本质是自由意志的沉沦
12-20 2818
1、缺少 XML 注释文件：Swagger 默认使用 XML 注释文件中的注释来生成接口文档。确保在项目的生成设置中启用了 XML 文档生成，并将生成的 XML 注释文件放置在与生成的 DLL 文件相同的目录下。2、修改Program.cs文件，在Build之前增加Swagger的配置项。，路径可以为空指向默认路径。请在右击->属性->生成。
swagger导出接口文档
热门推荐
王魂风气的博客
04-20 3万+
最近工作上需要用Swagger导出接口文档 经过查找资料总结了一下： Swagger简介 1、是一款让你更好的书写API文档的规范且完整框架。 2、提供描述、生产、消费和可视化RESTful Web Service。 3、是由庞大工具集合支撑的形式化规范。这个集合涵盖了从终端用户接口、底层代码库到商业API管理的方方面面。 简单来说，Swagger是一个帮助开发人员编写接口文档的工具，它可以帮你自...
获取项目中所有URL--获取swagger上展示的接口信息
weixin_30451709的博客
05-09 5354
有时我们需要接口的一些基本信息，比如接口请求路径，接口请求方式等，我们用这些信息来做判断，或者入库。 我在开发接口权限的时候就遇到了这个问题，之前写的接口很多，现在需要将这些接口信息存到数据库中， 用来做接口的权限操作，经过一番查阅，在此汇总了一下： @Autowired WebApplicationContext applicationContext; @Req...
Spring Boot 2.x基础教程：Swagger接口分类与各元素排序问题详解
程序猿DD
10-09 1034
点击蓝色“程序猿DD”关注我回复“资源”获取独家整理的学习资料！作者 | 翟永超来源 |didispace.com/spring-boot-learning-21-2-...
Pig接口开发范例详解以及常见问题汇总
peter_52的博客
11-22 740
如下图：其中，业务逻辑模块主要分为3个层：Controller层，Service层，Mapper层。接口数据定义模块主要是：VO接口数据显示层（即序列化的数据类）。
Swagger解析大全
spring_root的博客
09-12 2354
1.什么是Swagger OpenAPI规范（OpenAPI Specification 简称OAS）是Linux基金会的一个项目，试图通过定义一种用来描述API格式或API定义的语言，来规范RESTful服务开发过程，目前版本是V3.0，并且已经发布并开源在github上。 Swagger是符合OpenAPI规范的接口开发工具，支持从设计和文档到测试和部署的整个API生命周 期的开发。 (h...
【异常】swagger画面没显示controller
dyn的博客
02-11 2009
@Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) ...
【swagger】访问swagger-ui界面正常但是接口不展现
一只调皮可爱的小summy
11-11 8290
swagger-ui界面正常，接口不能展现
swaggerUI页面没有显示Controller方法
weixin_44026997的博客
06-16 4434
如上面两个图，ui界面未显示我配置的描述信息 解决方案如下： 第一步： 第二步： 启动类未加根包扫描 // 给启动类加注解，扫描根包 @SpringBootApplication(scanBasePackages = CommonCons.BASE_PACKAGE) public class SpringclouddemoApplication { public static void main(String[] args) { SpringApplication.run(S..
springboot 使用swagger 不显示basic-error-controller解决
攻防人生3722的博客
06-27 1万+
在启动类的主类下加入如下代码， `/* 配置 swagger开始 / @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).pathMapping(“/”).select() // 选择那些路径和api会生成documen...
swagger页面上接口显示不全的问题
qq_42582773的博客
06-02 7646
swagger使用注意
swagger接口文档无法正常显示接口信息问题解决
09-01 2951
背景：微服务项目其他模块的swagger都能正常显示接口文档信息，但其中一个模块的接口文档信息无法正常显示，如封面图片所示。经排查，pom.xml文件无误，接口上的相关注解也正确。但是缺少了一个配置类WebMvcConfig，这个配置类中包含了静态资源映射，由于找不到图片中的资源导致无法正常显示接口信息，调整后问题解决。
swagger不显示controller
03-16
Swagger不显示controller可能是因为以下原因： 1. 没有正确配置Swagger注解：在Controller类上添加@Api注解，以及在方法上添加@ApiOperation注解。 2. 没有正确配置Swagger依赖：需要在pom.xml文件中添加Swagger依赖，例如： ``` <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> ``` 3. 没有正确配置Swagger配置类：需要创建一个Swagger配置类，例如： ``` @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("com.example.controller")) .paths(PathSelectors.any()) .build(); } } ``` 以上是一些可能导致Swagger不显示controller的原因，可以根据具体情况进行排查和解决。
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值