springfox-swagger:3.0移除默认200状态码

本文介绍了在使用springfox-swagger时遇到的接口默认显示200状态码的问题,详细解析了200状态码何时被添加到OperationContext,并提供了通过自定义OperationBuilderPlugin实现类并利用反射技术移除200状态码的解决方案,适用于springfox3.0版本。
摘要由CSDN通过智能技术生成


前言

对于现在大部分前后端项目来说,后端的服务接口在设计时,大多数都会设计一套自定义状态码来对应不同模块的业务错误。基于这个前提,我们在使用springfox时,也需要给接口加入自己的自定义状态码,代码实现上也就是给接口加上@ApiResponses注解让springfox自己实现。但实际操作过程中发现最后的结果却永远多了一个200的状态码,且内容还是“OK”,这就很尴尬,虽然说不影响使用,但看着实在是令人不爽,所以就想着得把它干掉。一开始以为是一个简单的配置一下就行,所以就搜了一下,什么配置不使用默认响应,加注解等方法,操作一把后,结果都没什么鸟用,其他默认状态码可以去掉,这个200还是去不掉。没点可靠的,干脆还是自己撸一撸源码吧。


一、springfox到底是什么时候加入的200?

想要去掉200,那首先我们得知道它是什么时候被加入的。springfox的启动流程我们就以后抽个时间慢慢再做分析,不了解springfox的兄弟可以持续关注。大概就是Spring Plugin实现,通过注册Plugin实现动态插拔,更新springfox的OperationContext对象,我们的200状态码也就在OperationContext对象中,具体如下图所示:

在这里插入图片描述

通过以上debug出的属性结果可以知道,200状态码也就是任一OperationBuilderPlugin实现类中apply()方法里的operationContext参数,那么也就意味着是众多实现类中一个或多个加入了200状态码,这里就跳过源码阅读环节,直接跳到结果吧。

response设置情况分析结果
有颜色标记的实现类为加入了200状态码,此时我们找到了罪魁祸首。

二、如何去除200

对于如何去除200,最好的方式当然是自己写一个OperationBuilderPlugin实现类,修改responses属性即可。可情况并不是那么顺利,最后结论是springfox源码里定义的属性并不提供直接的外部访问和外部修改。直接上代码说一下解决过程。

首先不可避免的就是自定义实现类,修改responses属性

@Component
public class RemoveOkStatusCodeResponseMessageReaderimplements OperationBuilderPlugin {
   

    @Override
    public void apply(OperationContext operationContext) {
   
    		// 获取responses,返回结果是个set
            operationContext.operationBuilder().build().getResponses
  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
根据引用中的内容,解决swagger2.9.2报错 For input string: "" 的问题时,可以尝试将swagger的annotations以及models替换为1.5.21版本。在pom.xml文件中添加以下依赖: ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> <exclusions> <exclusion> <groupId>io.swagger</groupId> <artifactId>swagger-annotations</artifactId> </exclusion> <exclusion> <groupId>io.swagger</groupId> <artifactId>swagger-models</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>io.swagger</groupId> <artifactId>swagger-annotations</artifactId> <version>1.5.22</version> </dependency> <dependency> <groupId>io.swagger</groupId> <artifactId>swagger-models</artifactId> <version>1.5.22</version> </dependency> ``` 这样,你就能解决swagger2.9.2报错 For input string: "" 的问题了。如果你还遇到swagger不能传递参数的问题,可以参考引用中提供的博客链接,了解解决方案。 在使用swagger传递参数时,你可以使用@ApiParam注解,如引用所示。在方法的参数上添加@ApiParam注解,指定参数的名称、值和是否必需。这样,你就能够在swagger中正确传递参数了。但如果你仍然遇到Cannot resolve io.springfox:springfox-swagger-ui:unknown的问题,可能是你的项目中没有正确引入swagger-ui的依赖。你可以检查一下你的pom.xml文件,确保有以下依赖的配置: ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> ``` 这样,你就能够解决Cannot resolve io.springfox:springfox-swagger-ui:unknown的问题了。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* [解决idea中添加依赖遇见Cannot resolve XXX的问题](https://blog.csdn.net/qq_56392291/article/details/131025683)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT0_1"}}] [.reference_item style="max-width: 50%"] - *2* *3* [swagger使用问题收集](https://blog.csdn.net/DATANGguanjunhou/article/details/102733213)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT0_1"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值