如何从API生成中排除特定端点？求build.gradle.kts示例

你可以通过OpenAPI Generator插件的路径排除配置，直接跳过指定的API端点生成代码，这样新增的端点就不会出现在生成的接口中，自然无需编写存根来规避编译错误。

以下是build.gradle.kts的配置示例：

plugins {
    id("org.openapi.generator") version "7.6.0" // 使用最新稳定版插件，可根据项目调整
}

openApiGenerate {
    generatorName.set("spring") // 根据项目类型选择生成器，如spring、jaxrs等
    inputSpec.set("$rootDir/src/main/resources/openapi.yaml") // 你的OpenAPI Schema文件路径
    outputDir.set("$buildDir/generated/openapi") // 生成代码的输出目录
    apiPackage.set("com.yourcompany.api") // 生成的API接口包名
    modelPackage.set("com.yourcompany.model") // 生成的模型类包名

    // 核心配置：指定要排除的端点路径，支持通配符，多个路径用逗号分隔
    pathsToSkip.set("/experimental-endpoint/**,/new-analyst-added-endpoint")

    // 可选：若需更精细控制，可通过API类名（对应Schema的tags或operationId）批量排除
    globalProperties.set(mapOf(
        "apisToExclude" to "ExperimentalApi,NewFeatureApi"
    ))
}

// 让编译阶段依赖生成的代码
sourceSets {
    main {
        java {
            srcDir("$buildDir/generated/openapi/src/main/java")
        }
    }
}

关键配置说明 #

• pathsToSkip：直接匹配OpenAPI Schema中的路径，**通配符可匹配子路径，适合快速排除新增的实验性端点。
• apisToExclude：通过生成后的API接口类名（通常对应Schema里的tags）批量排除，适合按业务模块划分的端点。
• 插件版本请根据项目实际情况选择，确保与你的OpenAPI Schema版本兼容。

配置完成后，重新执行openApiGenerate任务，生成的接口代码会自动跳过指定端点，新增的实验性端点不会触发编译错误。

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