基于yml用openapi-generator-gradle-plugin生成RestTemplate遇报错如何解决
问题根因
报错的核心原因很直接:你当前使用的openapi-generator-gradle-plugin 4.3.0版本太老,这个版本的Spring代码生成器,本身就没有把resttemplate列为支持的可选library,内置可选库就只有报错提示里的spring-boot、spring-mvc、spring-cloud三类,传入resttemplate自然会触发未知库的校验拦截。resttemplate作为Spring生成器的官方支持选项,是在openapi-generator 5.0.0版本才正式合入的,设计目标就是在同一个生成任务里同时输出服务端接口定义+配套的RestTemplate调用客户端实现,4.3.0的迭代周期里根本没有做这个能力。
解决方案
方案一:升级插件版本(最贴合需求,优先选择)
- 修改build.gradle里buildscript块的插件版本,把4.3.0换成5.3.0及以上(这个版本之后resttemplate选项的稳定性最好,不会出现生成代码的兼容bug),对应配置行调整为:
classpath 'org.openapitools:openapi-generator-gradle-plugin:5.3.0' - 你原来写的
generatorName = "spring"、library = "resttemplate"配置完全保留即可,升级后这个参数值会被正常识别。 - 必须调整原有configOptions的配置项,不然会生成不完整的代码:
- 删掉两个原来面向纯服务端生成的专属配置:
interfaceOnly = "true"、delegatePattern = "true",这两个参数会强制生成器只输出空接口+委托类结构,直接屏蔽掉客户端实现的生成逻辑 - 可以补充两个适配当前技术栈的配置:
useSpringBoot3 = "false"(匹配你现在用的Spring Boot 2.2.1版本)、annotationLibrary = "spring",生成的客户端代码会自动带Spring组件注解,写完就能直接依赖注入使用。
- 删掉两个原来面向纯服务端生成的专属配置:
- 顺手修复现有依赖的版本冲突:你现在配置的spring-web版本是4.1.6.RELEASE,版本太低,要升到5.2.x以上,对齐插件生成代码的依赖要求,不然编译的时候会报一堆方法找不到的错误。
方案二:临时替代(无法升级插件时使用)
如果因为内网仓库的权限、缓存问题,暂时拉不到新版本的插件,不用硬卡spring生成器的resttemplate选项,直接换通用的Java客户端生成器即可,调整后的配置在4.3.0版本下完全可以正常运行:
openApiGenerate { generatorName = "java" library = "rest-template" inputSpec = "$rootDir/openapi-contracts/src/main/resources/openapi/api.yml".toString() outputDir = "$project.buildDir/generated/openapi" apiPackage = "ru.openapi.api.v1" modelPackage = "ru.openapi.model.v1" configOptions = [ dateLibrary : "java8", useBeanValidation : "true", enableBuilderSupport: "true" ] }
这个方式生成的纯RestTemplate客户端不会带Spring服务端的接口注解,需要你自己写个配置类初始化RestTemplate实例,绑定对应的客户端Bean,也能满足基础的服务调用需求。
内容的提问来源于stack exchange,提问作者Hakim Zubro
相关产品推荐
相关产品推荐

