AWS API Gateway含null值请求体报Invalid request body的解决及配置查询
问题根因
- 本地调试未接入API Gateway时,Spring Boot的Jackson序列化逻辑对入参的校验较为宽松,
default-property-inclusion: non_empty仅作用于响应出参的null值过滤,不会拦截请求体中显式传递的null字段,因此本地测试可以正常处理带null值的请求。 - 部署到AWS环境后,API Gateway基于导入的Swagger配置启用了请求体前置schema校验。该校验的默认规则是:非必填字段允许客户端不传递,但如果客户端显式传递了值,值必须匹配字段定义的基础类型——null值不属于string、number、object等常规类型的合法取值,因此会被直接拦截,返回"Invalid request body"错误,请求根本不会流转到后端Spring服务。
适配解决方案
需要先明确:AWS API Gateway没有与Spring Boot
default-property-inclusion: non_empty完全等效的配置项。二者的逻辑层级完全不同:前者是网关入口的前置拦截规则,后者是应用层的序列化/反序列化处理策略,无法通过单开关实现逻辑1:1匹配,可通过以下方式调整规避:
- 调整Swagger契约,显式声明可选字段允许null值
给所有需要接收null值的可选字段添加nullable: true属性,重新导入配置到API Gateway后即可生效。
对应schema配置示例:
注意:如果使用Swagger 2.0格式的契约,由于规范本身未定义nullable属性,导入后该配置会被API Gateway忽略,需要升级为OpenAPI 3.0格式再做调整。# 未配置时,网关会拦截var2: null的请求 var2: type: string description: 可选业务字段 # 配置后,网关允许var2接收null值 var2: type: string nullable: true description: 可选业务字段 - 关闭API Gateway层的请求体严格校验
如果后端Spring服务已经实现了完整的参数校验逻辑,可以直接在API Gateway对应路由的配置中,关闭「验证请求体」开关。关闭后网关不再对请求体做schema层面的前置拦截,会将原始请求体透传到后端,完全匹配本地调试时的校验逻辑。 - HTTP API(V2版本)的特殊处理
如果使用的是AWS HTTP API而非REST API,导入OpenAPI配置后会默认对定义了请求体的路由开启校验。除了上述添加nullable: true的配置方式,也可以直接移除OpenAPI文件中对应路由的requestBody定义,让网关跳过该路由的请求体校验。
常见踩坑提醒
- 常见的认知误区是“把字段从required列表移除,就可以任意传递包括null在内的值”,实际上API Gateway的校验规则对“不传递字段”和“显式传递null值”的处理是完全不同的。
- 不建议为了规避该问题修改API Gateway的请求映射转换模板,额外的转换逻辑会提升排障复杂度,优先通过调整契约或关闭校验的方式对齐网关与后端的校验逻辑即可。
内容的提问来源于stack exchange,提问作者A. Hafid
相关产品推荐
相关产品推荐

