OpenAPI3同方法名Endpoint的operationId自动加_1后缀如何解决
原因说明
OpenAPI规范强制要求所有接口的operationId全局唯一,你两个不同路径的接口方法名都是sayHi,Swagger默认生成operationId的规则是直接取Java方法名,遇到重名就会自动追加_1、_2这类后缀避免冲突,这是正常的默认处理逻辑。
解决方案
你可以根据自己的需求选任意一种实现:
方案1:仅加一行配置,无需改业务代码
直接在现有web.xml的Jersey Servlet配置中新增如下初始化参数即可:
<init-param> <param-name>openApi.configuration.operationIdWithFQN</param-name> <param-value>true</param-value> </init-param>
开启该配置后,operationId会自动使用「类全限定名+方法名」的格式生成,两个不同包下的sayHi方法生成的operationId天然不重复,就不会再追加后缀。
方案2:手动指定operationId,灵活性更高
如果不想用太长的全限定名,可以在每个sayHi方法上添加@Operation注解显式指定唯一的operationId:
首先确保引入了Swagger注解依赖,然后在方法上添加:
import io.swagger.v3.oas.annotations.Operation; // 示例:api1下的sayHi方法 @GET @Operation(operationId = "sayHiRes1") public String sayHi() { // 业务逻辑 } // 示例:api2下的sayHi方法 @GET @Operation(operationId = "sayHiRes2") public String sayHi() { // 业务逻辑 }
手动指定后会优先用你设置的值,不会走自动生成逻辑,自然也不会有后缀。
方案3:自定义生成规则
如果需要更灵活的生成逻辑,可以自己实现io.swagger.v3.oas.integration.api.OperationIdGenerator接口,然后在web.xml中添加配置指定自定义生成器即可:
<init-param> <param-name>openApi.configuration.operationIdGenerator</param-name> <param-value>你的自定义生成器全限定类名</param-value> </init-param>
内容的提问来源于stack exchange,提问作者NguSa1
相关产品推荐
相关产品推荐

