如何通过openapi-generator-maven-plugin生成完整OpenAPI客户端

问题根因 #

配置中的<generateSupportingFiles>false</generateSupportingFiles>是核心类缺失的直接原因。ApiClient、公共异常类、工具类都属于支持文件范畴，禁用支持文件生成后，插件只会生成API接口类，导致编译失败。从运行日志也可看到明确提示：Skipping generation of supporting files。

解决方案 #

1. 修改插件配置 #

将generateSupportingFiles改为true，也可以直接删除该配置项（插件默认值为true），修改后配置示例如下：

<plugin>
    <groupId>org.openapitools</groupId>
    <artifactId>openapi-generator-maven-plugin</artifactId>
    <version>5.1.0</version>
    <executions>
        <execution>
            <id>generate-client</id>
            <goals>
                <goal>generate</goal>
            </goals>
            <phase>process-resources</phase>
            <configuration>
                <inputSpec>${project.basedir}/src/main/openapi/api.json</inputSpec>
                <generatorName>java</generatorName>
                <generateApiDocumentation>false</generateApiDocumentation>
                <generateApiTests>false</generateApiTests>
                <generateSupportingFiles>true</generateSupportingFiles>
                <configOptions>
                    <sourceFolder>/</sourceFolder>
                </configOptions>
                <library>resttemplate</library>
            </configuration>
        </execution>
    </executions>
</plugin>

2. 可选优化（规避运行警告） #

你当前使用的OpenAPI 2.0规范缺失必填字段，可以补充内容消除警告：

• 在info节点下添加version字段，比如"version": "1.0.0"
• 新增schemes字段声明调用协议，比如"schemes": ["http"]

修改后的规范示例：

{
    "swagger": "2.0",
    "info": {
        "title": "Test",
        "version": "1.0.0"
    },
    "schemes": ["http"],
    "host": "localhost:8080",
    "basePath": "/",
    "tags": [
        {
            "name": "test-controller"
        }
    ],
    "paths": {
        "/test": {
            "get": {
                "tags": [
                    "test-controller"
                ],
                "operationId": "test",
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    }
}

修改完成后重新执行mvn clean compile即可正常生成所有必要类，不会再出现找不到ApiClient的编译错误。

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