SpringDoc OpenAPI 中 operationId 重复处理机制的问题与解决方案

问题背景

在 Spring Boot 应用中使用 SpringDoc OpenAPI 生成 API 文档时，开发人员可能会遇到一个特殊场景：当同一个 REST 端点需要支持多种内容类型（如 JSON 和表单数据）时，Spring MVC 要求我们为每种内容类型编写单独的处理方法。虽然 SpringDoc OpenAPI 能够正确地将这些方法合并为一个操作并列出所有支持的内容类型，但在处理 operationId 时却出现了意外的行为。

问题现象

当开发者为两个处理相同路径但不同内容类型的方法设置相同的 operationId 时，SpringDoc OpenAPI 会自动对这些 operationId 进行去重处理，导致最终生成的 OpenAPI 文档中出现类似 "create_1_1" 这样的修改后的 operationId，而不是开发者明确指定的 "create"。

技术分析

这个问题的根源在于 SpringDoc OpenAPI 的内部合并机制。当它检测到多个方法映射到同一个路径时：

1. 它会正确地合并请求体的不同内容类型描述
2. 但在处理 operationId 时，它采用了过于保守的去重策略
3. 即使开发者明确指定了相同的 operationId，系统仍然会强制修改

这种行为虽然可以避免潜在的 operationId 冲突，但在开发者明确控制 operationId 的情况下，反而造成了不必要的干扰。

解决方案

临时解决方案

开发者可以通过实现 GlobalOperationCustomizer 接口来覆盖默认的 operationId 处理逻辑：

@Component
public class PreserveOperationIdOpenApiCustomizer implements GlobalOperationCustomizer {
    @Override
    public Operation customize(Operation operation, HandlerMethod handlerMethod) {
        Optional.ofNullable(handlerMethod.getMethodAnnotation(Operation.class))
                .map(Operation::operationId)
                .ifPresent(operation::setOperationId);
        return operation;
    }
}

这个自定义处理器会：

1. 检查方法上的 @Operation 注解
2. 如果明确指定了 operationId，则使用该值
3. 否则保留默认行为

官方修复

根据项目维护者的反馈，这个问题已经在后续版本中得到修复。开发者可以升级到包含修复的版本（如 2.6.0 之后的版本）来获得正确的行为。

最佳实践

1. 对于需要支持多种内容类型的端点，建议：

   • 为每个内容类型编写单独的处理方法
   • 使用相同的 operationId
   • 确保方法签名正确处理各自的内容类型

2. 如果暂时无法升级到修复版本，可以使用上述的自定义处理器作为临时解决方案

3. 在设置 operationId 时，保持一致性，避免潜在的命名冲突

总结

SpringDoc OpenAPI 在处理多内容类型端点时的 operationId 去重行为虽然出于好意，但在开发者明确控制的情况下可能会带来困扰。理解这一机制后，开发者可以选择升级版本或使用自定义处理器来解决这个问题，确保生成的 API 文档符合预期。