spring集成swagger生成api文档的丢弃接口添加删除线效果

最新推荐文章于 2025-12-30 14:19:40 发布
原创 最新推荐文章于 2025-12-30 14:19:40 发布 · 2k 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#swagger

博客介绍了在API接口上添加注解的方式，只需直接在接口上添加注解即可。

直接在api接口上添加注解 @Deprecated 即可

【项目实战】在Spring Boot中，弃用某个无用的接口
奶爸的编程之路，也就一周冷个三天，欢迎关注我的微信公众号：本本本添哥
07-26 540
这是最直接的方法，只需要在代码中找到该接口，然后将其注释掉或直接删除。// // // 旧代码// // }// }自定义端点是通过Spring MVC或Spring WebFlux控制器实现的，并且你已经将其集成到了Spring Boot Actuator的端点管理中，或者你可以通过Spring Security等机制来控制访问。在你的application.yml文件中配置Spring Security，以禁用特定的自定义端点。
开放平台架构设计原理与实战：构建持续开放的开放平台开发流程
AI天才研究院
11-05 975
近年来，互联网经济蓬勃发展，人们越来越重视对自己信息的掌控权，希望在不受限制地分享自己的知识、经验和创造力。而早已开始普及的微信、微博、知乎等社交媒体则成为人们获取信息、沟通感情、表达观点的主要渠道。如此开放的网络空间也给平台创作者提供了巨大的想象空间。然而，当平台创作者构建自己的平台时，也面临着更复杂的技术难题——如何构建可持续、可扩展、安全的开放平台？如何让平台上的用户持续地提供新的价值？更重要的是，如何将平台上生成的数据产生价值，并且持续地推动平台运营？
抛弃swagger，不写注解生成接口文档
qq_25460159的博客
01-22 1730
之前用的swagger，必须要写注解才能在swagger文档中显示，测试起来也很方便，JAPIDOCS自动生成接口文档，不需要写任何注解，可以生成html形式的文档，还能生成docx格式的文档，我试了下，确实挺方便。 上图是我生成的文件。 这是生成的接口文档页面，包含controller中的方法。 参数，实体一目了然。还能生成安卓和ios的实体，前端开发可以直接复制粘贴走，省事很多。 上图是安卓实体。 上图是ios实体。 下面我来说说如何操作。 首先常规的添加...
swagger根据注解屏蔽大量不需要的接口
有情怀的程序员的博客
03-29 5690
公司一些老项目里加入了swagger，由于项目太大，接口巨多，扫描的无用的接口信息很恶心，用包路径区分的方式解决不了旧的controller上也有文档注解的问题。 偶然发现扫描api路径的时候可以选择只扫描带注解的，这个很实用，具体例子如下： return new Docket(DocumentationType.SWAGGER_2) .select() ...
Swagger 配置时 提示contact被弃用 解决办法
c_o_d_e_的博客
06-05 5663
踩坑记录 在配置文件Configuration中配置Swagger时，快捷键一键导包（STS快捷键是ctrl+shift+o）,然后就会弹出如下选择包的界面 这里选择包的时候就出了问题。我选择的时候没有弄清楚这两个包有何区别，就选择了第一个io.swagger.models.Contact，然后编写配置文件时就会提示contac被弃用，如下图 然后结果就是百思不得其解，我就将包删掉重新导入一次，这次没有忽视这个选择包的过程，选了了springfox.documentation...
如何实现swagger中表示接口过时了 Warning: Deprecated
xiaobai_tingyu的博客
12-18 1万+
如何实现swagger中表示接口过时了 Warning: Deprecated 在该接口的方法上添加@Deprecated @Deprecated简单来讲就是，若某类或某方法加上该注解之后，表示此方法或类不再建议使用，调用时也会出现删除线，但并不代表不能用，只是说，不推荐使用，因为还有更好的方法可以调用。 在swagger中的使用：     @ApiOperation(value = "通...
基于商城项目了解SpringCloud
kimdaydayup的博客
06-30 2146
SpringCloud及SpringCloudAlibaba是目前最流行的微服务技术栈。但大家学习起来的感受就是组件很多，不知道该如何应用。 这套《微服务开发与实战》从一个单体项目入手，带领大家从服务拆分时机、服务拆分原则、拆分遇到的问题入手，结合实际项目讲解。带你体会从单体到微服务中碰到的各种问题，并利用SpringCloud和SpringCloudAlibaba中的组件解决这些问题。让你真正了解到微服务组件在项目中的具体应用场景。
Spring & Spring Boot 架构设计与最佳实践面试题
最新发布
qq_16500963的博客
12-30 279
监控告警：基于 Metrics+Logging+Tracing 构建可观测体系，通过「告警定位范围→链路锁定节点→日志获取详情→交叉验证修复」实现快速排查。Spring AOP 解耦：通过「切面 + 注解」封装日志、权限、校验等非业务逻辑，实现业务与非业务代码分离，提高复用性。灾备架构：采用「同城多机房 + 跨区域部署」，数据层实时同步，应用层无状态设计，调度层自动切换，确保 RTO/RPO 达标。
API版本控制策略大全：3种主流方式利弊与落地实践
# API版本控制的演进与全生命周期治理 在智能家居设备日益复杂的今天，确保无线连接的稳定性已成为一大设计挑战。以智能音箱为例，其内部集成了Wi-Fi、蓝牙等多种通信协议，任何微小的信号干扰或兼容性问题都可能...
Java学习（下）
Lzdnydppx的博客
08-16 892
web开发、spring开发、spring boot开发、spring cloud开发
java接口废弃注释_Spring Boot如何让Web API自动生成文档，并解决swagger-annotations的API注解description属性废弃的问题...
weixin_33331021的博客
02-28 2806
前后端分离的系统架构中，前端开发人员需要查看后端WEB API的文档来进行开发。采用后端API文档自动生成的方式，可以大幅提高开发效率。swagger是一个被广泛使用的文档自动生成工具，可以与多种编程语言结合使用。我们可以利用合适的jar包，让swqgger来协助java开发。本文讲述了如何把 swagger 与 Spring Boot 框架结合起来使用。我用一个项目来解释如何完成上述的目标。打开...
swagger的注解
HelloKitty520123的专栏
06-21 203
@ApiOperation @ApiModelProperty @ApiModel
再见丑陋的 Swagger，这个API神器界面更炫酷，逼格更高，体验更好！
emprere的博客
02-22 177
代码未动，文档先行其实大家都知道 API 文档先行的重要性，但是在实践过程中往往会遇到很多困难。程序员最讨厌的两件事：1. 写文档，2. 别人不写文档。大多数开发人员不愿意写 API 文档...
Swagger注解的使用
热门推荐
骑个小蜗牛的博客
03-19 2万+
文章目录@EnableSwagger2@Api@ApiOperation@ApiParam@ApiImplicitParams@ApiImplicitParam@ApiModel@ApiModelProperty@ApiResponses@ApiResponse@ResponseHeader@ApiKeyAuthDefinition@Authorization@AuthorizationScope@BasicAuthDefinition@Contact@Example@ExampleProperty@Ext
Swagger2常用注解说明
xiaozm1223的博客
04-05 306
@Api：用在请求的类上，表示对类的说明： 常用参数： tags="说明该类的作用，非空时将覆盖value的值" value="描述类的作用" 其他参数： description 对api资源的描述，在1.5版本后不再支持 basePath 基本路径可以不配置，在1.5版本后不再支持 ...
swagger屏蔽某些接口
liben0429的博客
06-06 1万+
swagger会扫描package下面的所有接口，如果我有一些接口不想在页面中显示，应该如何做？ @ApiIgnore import org.apache.log4j.LogManager; import org.apache.log4j.Logger; import org.springframework.boot.autoconfigure.web.ErrorController; im...
【Swagger】常用注解及具体实例（超全）
A minor
01-29 2万+
在上一篇我们详细的介绍了使用 Swagger 时需要做的配置，现在已经能得到一个我们自己想要的页面了 但是，这也看不明白啊。。。接口连个中文说明都没有。。。所以，Swagger 提供了很多注解，就是让我们去为每个类、每个接口/参数、每个Model 写解释说明的。 1.用于类的注解 @Api：资源描述 标识这个类是 Swagger 的资源， @Api(tags = "商户相关接口") @RestController @RequestMapping("/merchants") public class Mer
swagger自定义访问接口前缀 (新增和删除)
weixin_43652507的博客
05-17 2136
swagger自定义访问接口前缀 (新增和删除)
swagger2 description is deprecated
gutou__yu的博客
06-11 8354
swagger2 description弃用原因解决方法 原因 在2.x之前，可以这么使用在Controller类上： @Api(value= "PmsBrandController", description = "商品品牌管理") 但是在2.x中，description被弃用了。 原因在于在2.x中有了标签（tags）的概念，可以将不同的controller标记为同一个标签。使标签的分组机制更加灵活。 为了符合API的要求，保持向后兼容，保留了description字段。 现在正确的方法应当针对tags
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值