【开发日记】Knife4j与Gateway搭配使用时请求前缀重复

原创于 2022-12-30 17:15:19 发布 · 1.2k 阅读

0 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#gateway #spring cloud #spring boot

开发日记同时被 2 个专栏收录

48 篇文章

订阅专栏

Web错误集锦

25 篇文章

订阅专栏

当使用Knife4j与Spring Cloud Gateway共同工作时，可能会遇到请求路径前缀重复的问题。为消除Swagger文档中不必要的前缀，只需在Gateway的配置文件中添加`spring.cloud.gateway.x-forwarded.prefix-enabled=false`。这一设置可以避免Swagger在生成API文档时再次添加已存在的前缀，从而保持路由配置的正常运作。

【问题】Knife4j与Gateway搭配使用时请求前缀重复了一个basePath

【解决】在Gateway模块配置文件中添加如下配置

spring:
  cloud:
    gateway:
      x-forwarded:
        prefix-enabled: false # 避免 Swagger 重复带上额外的前缀

其他配置照常，如routes等无需做出修改。