如何解决Swagger生成前端服务时方法命名非确定、随机加后缀问题

Swagger/OpenAPI代码生成工具默认以全局唯一的operationId作为前端方法命名的依据，未显式指定operationId时，生成器会直接取Java方法名作为operationId的推导值，全局去重时会随机为后遍历到的重名方法追加数字后缀，和方法所属的Controller分组无关，因此会出现命名随机的问题。

方案1：后端显式指定operationId（最推荐，从根源解决） #

在每个接口方法上添加注解手动指定全局唯一的operationId，生成器会直接使用该值作为前端方法名，不会自动追加后缀。

• 若使用SpringDoc OpenAPI（Swagger3），使用@Operation注解的operationId属性：

// PersonController.java
@Operation(operationId = "getPersonData")
@GetMapping("/person/data")
public ResponseEntity<String> getData() {
    return ResponseEntity.ok("Person Data");
}

// PetController.java
@Operation(operationId = "getPetData")
@GetMapping("/pet/data")
public ResponseEntity<String> getData() {
    return ResponseEntity.ok("Pet Data");
}

• 若使用旧版SpringFox Swagger2，使用@ApiOperation注解的nickname属性：

@ApiOperation(nickname = "getPersonData", value = "获取人员数据")
@GetMapping("/person/data")
public ResponseEntity<String> getData() {
    return ResponseEntity.ok("Person Data");
}

方案2：修改前端代码生成器配置（无需修改后端代码） #

如果你使用的是常用的openapi-generator工具生成前端代码，可以通过修改生成配置实现固定命名规则，避免随机后缀：
针对typescript系列的生成器（包括typescript-angular、typescript-axios等），开启prependOperationIdWithTag配置，生成方法名时会自动将接口所属的Tag（默认对应Controller类名）作为前缀，生成personControllerGetData、petControllerGetData格式的方法名，天然全局唯一，命名规则固定不会随机变化。

配置示例（命令行生成时添加参数）：

openapi-generator-cli generate -i ./openapi.json -g typescript-angular -o ./src/app/api --additional-properties=prependOperationIdWithTag=true

方案3：自定义命名规则（适合特殊需求） #

如果以上两种方案都不满足需求，可以自定义代码生成器的方法命名逻辑，按照「Controller名+方法名」的规则拼接方法名，完全避免全局重名问题。

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