swagger不想在前端显示的接口hidden=true没有用

鱿鱼ing 2020-08-13 02:27:55

各位有什么解决办法或者其他隐藏做法呢？谢谢！

...全文

4215 3 打赏收藏转发到动态举报

写回复

3 条回复

切换为时间正序

请发表友善的回复…

发表回复

还没谢顶的程序员 2021-02-22

打赏
举报

回复

可以使用@ApiIgnore注解标记在方法上参考：https://github.com/swagger-api/swagger-core/issues/1173

weixin_39918502 2020-11-15

打赏
举报

回复

整个controller下所有接口不想显示，在不想显示的controller上加注解@ApiIgnore就可以了，如果只是某个接口不想显示，可以在不想显示的接口上加注解@ApiOperation(hidden=true)

伱給的囘憶 2020-08-13

打赏
举报

回复

试试这个也 https://blog.csdn.net/lqh4188/article/details/53538201

本文深入探讨在若依(RuoYi)框架中如何巧妙运用@ApiParam(hidden = true)与@ApiIgnore注解实现Swagger接口的精准隐藏。针对安全、内部方法及特定参数等场景，详细解析了两种注解的核心用法、区别及最佳实践，旨在帮助开发者生成更清晰、安全、专业的API文档，提升项目管理水平。

本文介绍了如何在Spring Boot项目中集成Spring Security与Swagger（OpenAPI）实现基于角色的接口权限控制。主要内容包括：技术选型：使用Spring Boot 3.x + Spring Security 6.x + springdoc-openapi进行整合项目结构：采用标准分层架构，包含安全配置、控制器、服务层等模块权限模型：设计基于RBAC的用户角色体系（USER/ADMIN/AUDIT）核心实现：用户实体与角色实体的JPA定义自定义UserDetailsSe

一次偶然需求，有个别字段是给后端自己用的，不想在前端显示，网上有许多说设置一下 @ApiModelProperty( hidden = true) 就行，但是试了并没用，现有来看必须得自己重写部分源码实现注解第一步：创建swagger2要忽略的注解 import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; impo

本文针对若依(RuoYi)框架集成Swagger时，接口文档中自动显示HttpServletRequest与HttpSession等冗余参数的问题，提供了优雅的解决方案。核心方案是在Swagger配置类中使用`ignoredParameterTypes`方法全局忽略这些Servlet原生参数类型，从而生成简洁专业的API文档，提升前后端协作效率。

本文详细介绍了在若依（RuoYi）框架中优雅隐藏Swagger接口与参数的三种实用方法：使用@ApiParam(hidden=true)隐藏单个参数、利用@ApiIgnore灵活排除类或方法，以及通过配置分组实现批量条件化隐藏。文中附有具体代码示例，帮助开发者提升API文档的清晰度与安全性，优化团队协作效率。

51,408

社区成员

86,092

社区内容

发帖

与我相关

我的任务

javaspring bootspring cloud 技术论坛（原bbs）

社区管理员

加入社区

近7日
近30日
至今

加载中

查看更多榜单

社区公告

暂无公告

试试用AI创作助手写篇文章吧

+ 用AI写文章