首次为SpringBoot项目集成OpenAPI遇42Crunch扫描错误求解决

API1 响应格式不匹配问题 #

错误详情 #

1. The response is not valid: The body of the received response is not valid against the schema constraining it in the OpenAPI definition : path / value is not a string, got []interface {} '[string1 string2 string3]'

问题原因 #

手动通过ObjectMapper将列表转为JSON字符串返回，但OpenAPI定义的响应体schema是数组类型，42Crunch期望收到JSON数组，实际收到的是字符串类型的JSON内容，导致校验不通过。

解决办法 #

直接返回列表对象，SpringBoot自带的消息转换器会自动将其序列化为标准JSON数组，完全匹配OpenAPI的schema定义。
示例代码修改：

// 错误写法
String jsonStr = objectMapper.writeValueAsString(list);
return ResponseEntity.ok(jsonStr);

// 正确写法
return ResponseEntity.ok(list);

API2 请求参数校验失效问题 #

错误详情 #

• 接口接受了类型为object的请求参数，而非定义的number类型
• 接口接受了小于定义最小值的生成值
• 接口接受了超过整数/数值允许最大值的属性值
• 接口接受了类型为object的请求参数，而非定义的string类型

解决办法 #

1. 启用请求参数校验：在控制器类上添加@Validated注解，在请求参数/DTO字段上添加JSR-380校验注解，与OpenAPI定义的约束一一对应：

   • 对应number类型：Java字段用Integer/Double，添加@Min/@Max注解匹配OpenAPI的minimum/maximum
   • 对应string类型：Java字段用String，添加@NotBlank/@Pattern等注解匹配OpenAPI的格式约束

2. 确保代码与OpenAPI定义一致：

   • 若使用SpringDoc自动生成OpenAPI文档，通过@Schema注解明确字段类型、约束，比如：

     @Schema(type = "number", minimum = "10", maximum = "100")
     @Min(10)
     @Max(100)
     private Integer age;
     

   • 避免使用Object类型接收请求参数，严格按照OpenAPI定义的类型声明Java字段

3. 请求体校验：如果是POST/PUT请求，在控制器方法的请求体参数前添加@Valid注解，确保DTO内部的字段校验生效。

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