SpringDoc OpenAPI 中自定义注解的Schema配置问题解析

在使用SpringDoc OpenAPI为Spring Boot项目生成API文档时，开发者经常会遇到如何正确配置自定义注解以在Swagger UI中显示枚举值的问题。本文将深入分析这一常见问题的解决方案。

问题背景

在REST API开发中，我们经常需要限制某些参数的取值范围。例如，一个"证件类型"参数可能只允许"IDC"、"RUC"、"PAS"等特定值。理想情况下，这些限制应该在Swagger UI中明确显示，方便API使用者理解。

常见错误做法

许多开发者会尝试创建一个自定义注解，并使用@Schema注解来定义允许的值：

@Schema(
    description = "Tipo de documento",
    example = "IDC",
    type = "string",
    format = "enum",
    allowableValues = {"IDC", "RUC", "PAS"}
)
public @interface DocumentType {
}

然后在控制器方法中这样使用：

@GetMapping("/api/test")
public void testEndpoint(
    @DocumentType @RequestParam("identification_type") String identificationType
) {
    // 方法实现
}

然而，这种配置往往无法在Swagger UI中正确显示允许的值列表。

问题根源

问题的关键在于注解的保留策略(Retention Policy)。默认情况下，Java注解的保留策略是CLASS级别，这意味着注解信息在运行时不可用。而SpringDoc需要在运行时读取这些注解信息来生成API文档。

正确解决方案

要使自定义注解的Schema配置生效，必须显式指定注解的保留策略为RUNTIME：

@Schema(
    description = "证件类型",
    example = "IDC",
    type = "string",
    format = "enum",
    allowableValues = {"IDC", "RUC", "PAS"}
)
@Retention(RetentionPolicy.RUNTIME)  // 关键配置
public @interface DocumentType {
}

完整示例

以下是一个完整的控制器示例，展示了如何正确使用自定义注解：

@RestController
@RequestMapping("/api")
public class CustomerController {
    
    @Operation(
        summary = "获取客户消费记录",
        description = "根据证件信息查询客户消费记录"
    )
    @GetMapping("/consumptions")
    public ResponseEntity<List<Consumption>> listConsumptions(
        @DocumentType
        @RequestParam("identification_type") String identificationType,
        @RequestParam String identification,
        @Parameter(description = "起始日期，格式为YYYY-MM-DD")
        @RequestParam("date_since") @DateTimeFormat(pattern = "yyyy-MM-dd")
        LocalDate dateSince
    ) {
        // 业务逻辑实现
        return ResponseEntity.ok(Collections.emptyList());
    }
}

注意事项

1. 确保使用了正确的SpringDoc版本，本文示例基于2.6.0版本
2. 注解名称(name属性)应与参数名一致，避免混淆
3. 对于复杂的参数组合，考虑使用DTO对象而非多个单独参数
4. 在开发环境中测试时，确保清除浏览器缓存，避免看到旧的Swagger UI页面

总结

通过正确配置自定义注解的保留策略，开发者可以充分利用SpringDoc OpenAPI的强大功能，为API使用者提供清晰、准确的参数约束信息。这不仅提高了API的可用性，也减少了因参数错误导致的接口调用失败。