spring boot中通过实现ResponseBodyAdvice接口并使用@RestControllerAdvice注解响应返回之前对数据进行统一处理,影响swagger文档出现Petstore

@RestControllerAdvice
public class ApiResponseAdvice implements ResponseBodyAdvice<Object> {
    @Autowired
    private ObjectMapper objectMapper;


    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        return true;
    }

    @SneakyThrows
    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        // 处理String类型
        if (o instanceof String) {
            return objectMapper.writeValueAsString(ResponseData.success(o));
        }
        // 若是统一返回类型,则不用再此封装
        if (o instanceof ResponseData) {
            return o;
        }
        // 排除Swagger相关路径,否则会导致文档读取异常,直接出现文档出现的是Petstore文档
        if (serverHttpRequest.getURI().getPath().contains("/v3/api-docs")
                || serverHttpRequest.getURI().getPath().contains("/swagger-ui")) {
            return o;
        }
        return ResponseData.success(o);
    }
}
  1. 这段代码是一个全局响应体处理的切面,用于在Spring
    MVC的响应返回之前对数据进行统一处理,以符合特定的响应格式(在这个例子中是ResponseData)。它通过实现ResponseBodyAdvice接口并使用@RestControllerAdvice注解来全局生效。
  2. 当SpringDoc生成API文档时,它会调用实际的API端点来获取元数据,包括响应类型和模型。你的beforeBodyWrite方法逻辑中,不论原始返回对象是什么类型,最终都会被包装成ResponseData对象(除非它本身就是ResponseData的实例)。这意味着SpringDoc在尝试解析响应模型时,实际上看到的是ResponseData,而非实际API方法原本应直接返回的具体类型。

导致以下问题:
模型失真:API文档中原本应该展示的实际返回类型被统一的ResponseData替代,使得文档无法准确反映每个API的真实返回结构。
Swagger UI显示问题:由于返回类型统一被转换,Swagger UI可能无法正确渲染这些经过二次处理的响应模型,尤其是当直接返回字符串(如JSON字符串)被转换时。
为了解决这个问题同时保持响应体的统一处理,在beforeBodyWrite增加

  // 排除Swagger相关路径,否则会导致文档读取异常,直接出现文档出现的是Petstore文档
  if (serverHttpRequest.getURI().getPath().contains("/v3/api-docs")
          || serverHttpRequest.getURI().getPath().contains("/swagger-ui")) {
      return o;
  }
  • 11
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值