升级OpenAPI Generator后Go客户端编译报错的解决方法

问题场景 #

将hivelocity-client-go仓库的Makefile中GENERATOR_VERSION从4.3.1升级到6.2.1后，执行make命令出现以下错误：

go build github.com/hivelocity/hivelocity-client-go/client
go test ./...
# github.com/hivelocity/hivelocity-client-go/client/test
client/test/api_account_test.go:13:2: local import "./openapi" in non-local package
FAIL    github.com/hivelocity/hivelocity-client-go/client/test [setup failed]
?       github.com/hivelocity/hivelocity-client-go/client       [no test files]
FAIL
make: *** [Makefile:17: client] Error 1

生成的client包代码中存在无效导入：

package client

import (
    openapiclient "./openapi"

但项目中不存在./openapi目录或包。

原因分析 #

OpenAPI Generator从4.x版本升级到6.x版本后，Go客户端的代码生成规则发生了变化：

• 旧版本默认将API模型代码生成在client目录下的子目录，且使用本地相对路径导入
• 新版本对Go模块的支持更严格，默认生成的导入路径不再适配旧目录结构，同时Go模块禁止在非本地包中使用./xxx这类本地导入路径

解决方案 #

1. 调整OpenAPI Generator生成命令参数 #

修改Makefile中的代码生成命令，添加模块路径参数，确保生成的代码使用正确的模块导入路径。

假设原生成命令类似：

openapi-generator generate -i openapi.yaml -g go -o client --package-name client

修改为：

openapi-generator generate -i openapi.yaml -g go -o . --module github.com/guettli/hivelocity-client-go --package-name openapi

该命令会将openapi相关代码生成在项目根目录的openapi文件夹下，同时生成的导入路径会使用完整的模块路径github.com/guettli/hivelocity-client-go/openapi。

2. 更新client包的导入路径 #

如果保留原目录结构，需要手动修正client包中的导入语句，将本地路径替换为完整模块路径：

// 替换前
import (
    openapiclient "./openapi"
)

// 替换后
import (
    openapiclient "github.com/guettli/hivelocity-client-go/openapi"
)

同时同步修正client/test目录下测试文件的导入路径。

3. 清理旧代码并重新生成 #

执行以下命令清理旧生成代码，再重新运行make：

rm -rf client openapi
make

4. 验证生成结果 #

检查生成的代码中导入路径是否正确，确保openapi目录存在且包含对应的模型和API代码，再次执行make或go test ./...验证错误是否消除。

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