swagger页面上接口显示不全的问题

时间:2025-03-16 08:14:40

前言

swagger是一个非常好用的工具,非常适合在这个前后端分离开发的时代。

问题描述

这个问题的情况就是在某一个controller中有某一个接口信息(比如:/addUser),但是在我们去访问swagger的时候,却发现在这个controller对应的tab下却没有这个接口的信息

排查

①本想着可能是添加了@Deprecated注解,但是一想,好像在这种情况下,swagger页面上是可以看得到这个接口信息的,只是被禁用了;所以排除
②经过网络咨询,有可能这个请求路径在其他controller中已经使用过了,所以不显示,但是,经过在页面上查询,却没有这个接口信息;所以排除
③看代码,发现,这个接口上面在使用swagger接口描述注解@ApiOperation的时候设置了hidden属性为true,所以在swagger页面上这个接口信息就被隐藏了,如果要显示,我们将这个swagger属性设置为true即可。