SpringDoc OpenAPI 中 GET 请求使用 @RequestBody 的规范解析

在 Spring Boot 应用开发中，SpringDoc OpenAPI 是一个广泛使用的库，用于自动生成 OpenAPI 规范文档。最近有开发者反馈了一个关于在 GET 请求方法中使用 @RequestBody 注解时文档生成不符合预期的问题，这实际上涉及到了 OpenAPI 规范本身的设计理念和技术演进。

问题现象

当开发者在 GET 请求方法上使用 @RequestBody 注解时，例如：

@GetMapping("test")
public void getWithRequestBody(@RequestBody MyClass myClass) {
}

生成的 OpenAPI 文档会将参数 myClass 错误地描述为查询参数（"in": "query"），而不是预期的请求体（requestBody）。这种差异会导致 API 文档与实际接口行为不一致。

技术背景解析

这个问题本质上源于 OpenAPI 规范不同版本对于 GET 请求携带请求体的处理方式：

1. OpenAPI 3.0 规范：明确不支持在 GET 请求中定义请求体。这是基于 HTTP/1.1 规范（RFC7231）的建议，该规范指出 GET 请求携带请求体没有明确定义的语义，可能导致某些现有实现拒绝该请求。

2. OpenAPI 3.1 规范：放宽了这一限制，允许在 GET 请求中定义请求体，为特殊场景提供了灵活性。

解决方案

针对这个问题，开发者有以下几种选择：

1. 升级到 OpenAPI 3.1：如果项目能够使用最新规范，这是最直接的解决方案。SpringDoc OpenAPI 2.6.0 及以上版本支持 OpenAPI 3.1 规范。

2. 修改 API 设计：遵循 RESTful 最佳实践，GET 请求通常不应该携带请求体。可以考虑：

   • 将参数改为查询参数或路径参数
   • 改用 POST 方法（如果操作本质上是非幂等的）

3. 使用自定义注解处理：对于必须使用 GET 请求体且无法升级 OpenAPI 版本的情况，可以通过自定义注解和解析器来实现特殊处理。

技术建议

在实际开发中，建议开发者：

1. 理解 REST 设计原则，GET 请求主要用于获取资源，其参数应该体现在 URL 中（查询参数或路径参数）。

2. 对于复杂的查询条件，可以考虑：

   • 使用 POST 方法配合 @RequestBody
   • 设计专门的查询端点（如 /search）
   • 使用 GraphQL 等替代方案

3. 保持 API 设计的一致性，避免混合使用不同风格的参数传递方式。

总结

SpringDoc OpenAPI 库的行为实际上是遵循 OpenAPI 规范的结果，而不是库本身的限制。开发者在设计 API 时应该理解底层规范的设计理念，选择最适合业务需求的方案。对于必须使用 GET 请求体的特殊场景，确保使用支持该特性的 OpenAPI 3.1 规范，并在文档中明确说明这种非标准用法的原因和预期行为。