Spring Cloud Gateway网关下的文档聚合(knife4j)

在Spring Cloud Gateway网关下使用Knife4j进行文档聚合,你需要首先配置好Knife4j,并确保所有需要被文档化的服务都已经接入Knife4j。以下是一个简化的步骤和示例代码:

  1. 在每个服务中添加Knife4j依赖:



<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>最新版本</version>
</dependency>
  1. 在每个服务的application.ymlapplication.properties中配置Knife4j:



# 配置Knife4j
knife4j.enable=true
knife4j.basic=
  username: your-username
  password: your-password
  1. 在网关服务中,使用Knife4j提供的SwaggerResource类来获取各个服务的Swagger配置,并通过Spring Cloud Gateway的路由功能将这些配置暴露出来。

示例代码:




@Configuration
public class Knife4jConfig {
 
    @Autowired(required = false)
    private List<RouteLocator> routeLocators = new ArrayList<>();
 
    @Autowired
    private GatewayProperties gatewayProperties;
 
    @Bean
    public SwaggerResourcesProvider swaggerResourcesProvider() {
        return () -> {
            List<SwaggerResource> resources = new ArrayList<>();
            routeLocators.forEach(routeLocator -> routeLocator.getRoutes().forEach(route -> {
                // 假设服务名称和服务路径相同
                String serviceName = route.getId();
                resources.add(swaggerResource(serviceName, route.getUri().toString() + "/v2/api-docs"));
            }));
            return resources;
        };
    }
 
    private SwaggerResource swaggerResource(String name, String location) {
        SwaggerResource swaggerResource = new SwaggerResource();
        swaggerResource.setName(name);
        swaggerResource.setLocation(location);
        swaggerResource.setSwaggerVersion("2.0");
        return swaggerResource;
    }
}
  1. 在网关服务中创建一个Controller来响应Knife4j的文档请求:



@RestController
@RequestMapping("/swagger-resources")
public class SwaggerHandler {
    @Autowired
    private SwaggerResourcesProvider swaggerResourcesProvider;
 
    @GetMapping("/configuration/security")
    public ResponseEntity<SecurityConfiguration> securityConfiguration() {
        return ResponseEntity.ok(new SecurityConfiguration("basicAuth", new ArrayList<>()));
    }
 
    @GetMapping("/configuration/ui")
    public ResponseEntity<UiConfiguration> uiConfiguration() {
        return ResponseEntity.ok(new UiConfiguration(null, null, null, null, UiConfiguration.Constants.OPERATION_NONE, 1000L));
    }
 
    @GetMapping("/")
    public ResponseEntity<List<SwaggerResource>> swaggerResources() {
        retur
最后修改于:2024年08月29日 09:20

评论已关闭

推荐阅读

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日