SpringCloudGateway整合swagger3文档

Spring Cloud Gateway 整合 Swagger 3 文档需要通过自定义过滤器来转发 Swagger 的 API 文档。以下是一个简单的示例:

  1. 添加依赖(确保你已经添加了Spring Cloud Gateway和Spring Boot的相关依赖):



<!-- Swagger 3 依赖 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
  1. 配置 Swagger:



@Configuration
@EnableSwagger2
public class SwaggerConfig {
 
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}
  1. 自定义过滤器转发 Swagger 文档:



@Component
public class SwaggerHeaderFilter extends AbstractGatewayFilterFactory {
 
    @Override
    public GatewayFilter apply(Object config) {
        return (exchange, chain) -> {
            ServerHttpRequest request = exchange.getRequest();
            String path = request.getURI().getPath();
 
            // 仅转发 Swagger 的 API 文档请求
            if (path.startsWith("/swagger") || path.startsWith("/v3/api-docs")) {
                ServerHttpRequest newRequest = request.mutate()
                        .header(HttpHeaders.ACCESS_CONTROL_ALLOW_ORIGIN, "*")
                        .build();
                return chain.filter(exchange.mutate().request(newRequest).build());
            }
            return chain.filter(exchange);
        };
    }
}
  1. application.ymlapplication.properties 中配置 SwaggerHeaderFilter:



spring:
  cloud:
    gateway:
      routes:
        - id: swagger_route
          uri: http://your-backend-service
          predicates:
            - Path=/your-backend-service/**
          filters:
            - SwaggerHeaderFilter

确保替换 your-backend-service 为你的后端服务的实际路径。

这样配置后,当你访问 http://your-gateway-service/swagger-ui.htmlhttp://your-gateway-service/v3/api-docs 时,Gateway 会转发请求到后端服务,并返回 Swagger 文档。

最后修改于:2024年09月02日 19:06

评论已关闭

推荐阅读

DDPG 模型解析,附Pytorch完整代码
2024年11月24日
DQN 模型解析,附Pytorch完整代码
2024年11月24日
AIGC实战——Transformer模型
2024年12月01日
Socket TCP 和 UDP 编程基础(Python)
2024年11月30日
python , tcp , udp
如何使用 ChatGPT 进行学术润色?你需要这些指令
2024年12月01日
AI
最新 Python 调用 OpenAi 详细教程实现问答、图像合成、图像理解、语音合成、语音识别(详细教程)
2024年11月24日
ChatGPT 和 DALL·E 2 配合生成故事绘本
2024年12月01日
omegaconf,一个超强的 Python 库!
2024年11月24日
【视觉AIGC识别】误差特征、人脸伪造检测、其他类型假图检测
2024年12月01日
[超级详细]如何在深度学习训练模型过程中使用 GPU 加速
2024年11月29日
Python 物理引擎pymunk最完整教程
2024年11月27日
MediaPipe 人体姿态与手指关键点检测教程
2024年11月27日
深入了解 Taipy:Python 打造 Web 应用的全面教程
2024年11月26日
基于Transformer的时间序列预测模型
2024年11月25日
Python在金融大数据分析中的AI应用(股价分析、量化交易)实战
2024年11月25日
AIGC Gradio系列学习教程之Components
2024年12月01日
Python3 `asyncio` — 异步 I/O,事件循环和并发工具
2024年11月30日
llama-factory SFT系列教程:大模型在自定义数据集 LoRA 训练与部署
2024年12月01日
Python 多线程和多进程用法
2024年11月24日
Python socket详解,全网最全教程
2024年11月27日