如何在Maven插件中聚合多个独立OpenAPI文件的Paths并生成文件？

1. 合并依赖的Paths到当前项目的OpenAPI对象 #

你已经能解析依赖的component-descriptor.yaml为OpenAPI Java对象，接下来只需将这些对象中的Paths合并到当前项目的OpenAPI对象中即可：

// 假设currentOpenApi是当前项目解析后的OpenAPI实例
OpenAPI currentOpenApi = ...;
Map<String, PathItem> currentPaths = currentOpenApi.getPaths();

// 初始化Paths集合（如果当前项目文件中没有Paths节点）
if (currentPaths == null) {
    currentPaths = new HashMap<>();
    currentOpenApi.setPaths(currentPaths);
}

// 遍历所有依赖的OpenAPI对象，合并Paths
for (OpenAPI dependencyOpenApi : dependencyOpenApis) {
    Map<String, PathItem> dependencyPaths = dependencyOpenApi.getPaths();
    if (dependencyPaths != null && !dependencyPaths.isEmpty()) {
        // 处理路径冲突：这里示例为覆盖已有路径，可根据需求调整逻辑
        dependencyPaths.forEach((path, pathItem) -> {
            if (currentPaths.containsKey(path)) {
                // 可选：添加日志提示路径重复
                getLog().warn("路径 {} 已存在，将覆盖原有定义", path);
            }
            currentPaths.put(path, pathItem);
        });
    }
}

2. 将合并后的OpenAPI对象导出为YAML文件 #

使用Swagger Core提供的Yaml工具类，就能把合并后的OpenAPI对象序列化为YAML格式并写入文件：

import io.swagger.v3.core.util.Yaml;
import java.io.FileWriter;
import java.io.IOException;

// 序列化为格式化的YAML字符串
String mergedYamlContent = Yaml.pretty(currentOpenApi);

// 写入到目标文件（替换为你实际的文件路径）
try (FileWriter writer = new FileWriter("src/main/resources/component-descriptor.yaml")) {
    writer.write(mergedYamlContent);
} catch (IOException e) {
    // 异常处理，可根据Maven插件的日志体系调整
    getLog().error("写入合并后的OpenAPI文件失败", e);
}

关键注意事项 #

• 依赖版本：确保你的Maven插件依赖了io.swagger.core.v3:swagger-core 2.2.x及以上版本，这些API在该版本后稳定支持。
• 路径冲突策略：如果多个依赖存在相同路径，需根据项目需求决定处理方式——比如保留当前项目的路径定义、覆盖、或者抛出异常终止构建。
• 非Paths字段保留：当前项目的info、tags等其他字段会完全保留，合并操作仅针对Paths节点。

内容的提问来源于stack exchange，提问作者Miss Skooter