Swagger/OpenAPI生成Spring代码时required失效,如何实现POST缺参返回400?
问题根源
- 当前Maven插件配置将
useBeanValidation设置为false,代码生成时不会为OpenAPI定义中标注为required的字段生成标准Bean Validation校验注解,仅保留用于接口文档展示的@ApiModelProperty(required = true)。 @ApiModelProperty本身无运行时校验能力,Spring MVC默认不会直接解析OpenAPI规则做参数拦截,Jackson默认反序列化逻辑也不会对缺失字段抛错,最终导致缺失必填字段的请求可以正常进入业务流程。
修复操作步骤
- 第一步:调整openapi-generator-maven-plugin配置
将configOptions节点下的useBeanValidation配置值修改为true,重新执行代码生成:
重新生成的实体类中,OpenAPI标记为必填的字段会自动带上<configOptions> <interfaceOnly>true</interfaceOnly> <modelPackage>portal</modelPackage> <skipDefaultInterface>true</skipDefaultInterface> <!-- 开启BeanValidation注解生成能力 --> <useBeanValidation>true</useBeanValidation> </configOptions>@NotNull、@NotBlank等JSR标准校验注解。 - 第二步:在接口入参处激活校验流程
确保Controller方法中接收@RequestBody参数的位置追加@Valid注解,Spring才会对入参对象上的校验注解触发校验逻辑:@PostMapping("/mission") public ResponseEntity<Void> createMission(@RequestBody @Valid MissionContext missionContext) { // 业务处理 } - 第三步:补充校验模块依赖
项目当前未引入任何校验相关依赖,需要引入Spring Boot校验启动器,否则校验逻辑不会生效:<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency>
最终效果
配置完成后,当POST请求体缺失missionName必填字段时,Spring会在进入Controller方法前就触发校验拦截,抛出MethodArgumentNotValidException,自动返回400状态码及对应的字段缺失错误信息。
注意:所有运行时参数校验的触发,都依赖Bean Validation标准注解和Spring的校验激活逻辑,Swagger相关的注解仅用于接口文档展示,不承担运行时校验职责。
内容的提问来源于stack exchange,提问作者Adrian Klimczak
相关产品推荐
相关产品推荐

