openapi-generator-maven-plugin去除生成方法UsingGET后缀
移除生成接口方法UsingGET后缀的配置方法
OpenAPI Generator Spring生成器默认追加UsingGET/UsingPOST等HTTP方法后缀,是为了避免同路径不同请求方法的接口出现方法名冲突,可通过插件配置直接关闭该行为。
- 配置修改
打开pom.xml中openapi-generator-maven-plugin的配置,在<configOptions>节点内新增配置项:
<methodNamingConvention>original</methodNamingConvention>
该配置适用于你当前使用的5.4.0版本,配置后生成器会直接使用YAML文件中定义的operationId作为接口方法名,不会额外追加HTTP方法后缀。
如果该配置不生效,可替换为旧版兼容参数(5.4.0版本仍支持,后续版本已废弃):
<useMethodName>true</useMethodName>
修改完成后的configOptions参考:
<configOptions> <skipDefaultInterface>true</skipDefaultInterface> <interfaceOnly>true</interfaceOnly> <sourceFolder>generated-sources</sourceFolder> <dateLibrary>legacy</dateLibrary> <returnResponse>true</returnResponse> <library>spring-boot</library> <useTags>true</useTags> <hideGenerationTimestamp>true</hideGenerationTimestamp> <useSwaggerAnnotations>true</useSwaggerAnnotations> <serializableModel>true</serializableModel> <delegatePattern>false</delegatePattern> <methodNamingConvention>original</methodNamingConvention> </configOptions>
- 重新生成代码
配置修改完成后,执行Maven命令清理旧的生成产物,重新生成接口:
mvn clean generate-sources
- 注意事项
关闭后缀自动追加后,需要自行保证YAML定义中所有接口的operationId全局唯一,否则会生成同名方法,导致编译报错。
内容的提问来源于stack exchange,提问作者Hamza Babahsine
相关产品推荐
相关产品推荐

