如何使用Java从OpenAPI（Swagger）规范文件中获取指定API路径

要处理OpenAPI 3.0的YAML文件，获取并修改指定路径/servicepath/myservice，我们可以借助OpenAPI Java解析库来完成，下面是具体的实现步骤：

一、引入依赖 #

首先需要在项目中添加OpenAPI解析相关的依赖，这里以Maven为例，使用swagger-parser（它完美支持OpenAPI 3.0规范）：

<dependency>
    <groupId>io.swagger.parser.v3</groupId>
    <artifactId>swagger-parser</artifactId>
    <version>2.1.16</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-yaml</artifactId>
    <version>2.15.2</version>
</dependency>

二、解析YAML文件到OpenAPI对象 #

先把本地的YAML文件解析成Java对象，这样我们就能方便地操作它的结构：

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.parser.OpenAPIParser;
import io.swagger.v3.parser.core.models.SwaggerParseResult;

import java.io.File;

public class OpenApiModifier {
    public static void main(String[] args) {
        // 1. 解析目标YAML文件
        File yamlFile = new File("path/to/your/openapi.yaml");
        SwaggerParseResult parseResult = new OpenAPIParser().readLocation(yamlFile.getAbsolutePath(), null, null);
        OpenAPI openAPI = parseResult.getOpenAPI();

        // 检查解析是否出错
        if (!parseResult.getMessages().isEmpty()) {
            System.err.println("解析失败：" + parseResult.getMessages());
            return;
        }

三、获取并修改指定路径 #

OpenAPI对象中的paths本质是一个Map<String, PathItem>，key就是路径字符串，value是对应路径的详细配置。我们可以直接通过key获取目标路径，然后按需修改：

1. 获取目标PathItem对象 #

// 2. 获取指定路径的配置对象
        String targetPath = "/servicepath/myservice";
        io.swagger.v3.oas.models.PathItem pathItem = openAPI.getPaths().get(targetPath);

        if (pathItem == null) {
            System.err.println("目标路径不存在：" + targetPath);
            return;
        }

2. 修改PathItem的内容 #

这里举几个常见的修改场景：

// 示例1：修改该路径下GET操作的标签
        if (pathItem.getGet() != null) {
            pathItem.getGet().setTags(List.of("UpdatedMyService", "Admin"));
        }

        // 示例2：给该路径新增一个POST操作
        io.swagger.v3.oas.models.Operation postOperation = new io.swagger.v3.oas.models.Operation()
                .tags(List.of("MyService"))
                .summary("创建资源")
                .description("通过POST请求创建新的业务资源");
        pathItem.setPost(postOperation);

        // 示例3：修改路径本身（比如替换旧路径为新路径）
        String newPath = "/servicepath/updated-myservice";
        openAPI.getPaths().remove(targetPath);
        openAPI.getPaths().put(newPath, pathItem);

四、将修改后的对象写回YAML文件 #

最后把修改后的OpenAPI对象重新序列化为YAML文件：

// 3. 写入修改后的YAML文件
        try {
            com.fasterxml.jackson.databind.ObjectMapper mapper = new com.fasterxml.jackson.databind.ObjectMapper(new com.fasterxml.jackson.dataformat.yaml.YAMLFactory());
            mapper.writeValue(new File("path/to/your/updated-openapi.yaml"), openAPI);
            System.out.println("文件修改完成！");
        } catch (Exception e) {
            System.err.println("写入文件失败：" + e.getMessage());
        }
    }
}

关键说明 #

• OpenAPI类是整个规范的根对象，包含了info、paths等所有顶级属性
• Paths本质就是一个Map，所以可以像操作普通Map一样添加、删除、修改路径
• 所有OpenAPI模型类都在io.swagger.v3.oas.models包下，你可以根据需求修改任何层级的属性

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