Skip to content

Fix validation constraints for parameters in request body of form request are not generated (at least with Spring Boot generator) #21749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 4 commits into from
Aug 23, 2025
Merged

Fix validation constraints for parameters in request body of form request are not generated (at least with Spring Boot generator) #21749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2ce1267
fix(Spring Boot): adds validation to body params of forms requests
oliverkuntze Aug 14, 2025
e847cbe
fix(Spring Boot): adds test for validation of body params of forms re…
oliverkuntze Aug 14, 2025
d761b7d
Merge branch 'OpenAPITools:master' into fix-form-request-param-valida…
oliverkuntze Aug 16, 2025
903a1b6
fix(Spring Boot): adds samples
oliverkuntze Aug 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/JavaSpring/formParams.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{{#isFormParam}}{{^isFile}}{{>paramDoc}}{{#useBeanValidation}} @Valid{{/useBeanValidation}} {{#isModel}}@RequestPart{{/isModel}}{{^isModel}}{{#isArray}}@RequestPart{{/isArray}}{{^isArray}}{{#reactive}}@RequestPart{{/reactive}}{{^reactive}}@RequestParam{{/reactive}}{{/isArray}}{{/isModel}}(value = "{{baseName}}"{{#required}}, required = true{{/required}}{{^required}}, required = false{{/required}}){{>dateTimeParam}} {{^required}}{{#useOptional}}Optional<{{/useOptional}}{{/required}}{{{dataType}}}{{^required}}{{#useOptional}}>{{/useOptional}}{{/required}} {{paramName}}{{/isFile}}{{#isFile}}{{>paramDoc}} @RequestPart(value = "{{baseName}}"{{#required}}, required = true{{/required}}{{^required}}, required = false{{/required}}) {{#reactive}}{{#isArray}}Flux<{{/isArray}}Part{{#isArray}}>{{/isArray}}{{/reactive}}{{^reactive}}{{#isArray}}List<{{/isArray}}MultipartFile{{#isArray}}>{{/isArray}}{{/reactive}} {{paramName}}{{/isFile}}{{/isFormParam}}
{{#isFormParam}}{{^isFile}}{{>paramDoc}}{{#useBeanValidation}} {{>beanValidationBodyParams}}@Valid{{/useBeanValidation}} {{#isModel}}@RequestPart{{/isModel}}{{^isModel}}{{#isArray}}@RequestPart{{/isArray}}{{^isArray}}{{#reactive}}@RequestPart{{/reactive}}{{^reactive}}@RequestParam{{/reactive}}{{/isArray}}{{/isModel}}(value = "{{baseName}}"{{#required}}, required = true{{/required}}{{^required}}, required = false{{/required}}){{>dateTimeParam}} {{^required}}{{#useOptional}}Optional<{{/useOptional}}{{/required}}{{{dataType}}}{{^required}}{{#useOptional}}>{{/useOptional}}{{/required}} {{paramName}}{{/isFile}}{{#isFile}}{{>paramDoc}} @RequestPart(value = "{{baseName}}"{{#required}}, required = true{{/required}}{{^required}}, required = false{{/required}}) {{#reactive}}{{#isArray}}Flux<{{/isArray}}Part{{#isArray}}>{{/isArray}}{{/reactive}}{{^reactive}}{{#isArray}}List<{{/isArray}}MultipartFile{{#isArray}}>{{/isArray}}{{/reactive}} {{paramName}}{{/isFile}}{{/isFormParam}}
36 changes: 36 additions & 0 deletions ...enapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2743,6 +2743,42 @@ public void useBeanValidationGenerateAnnotationsForRequestBody_issue13932() thro
.containsWithNameAndAttributes("Min", ImmutableMap.of("value", "2"));
}

@Test
public void useBeanValidationGenerateAnnotationsForFormsRequestBody() throws IOException {
File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
output.deleteOnExit();

OpenAPI openAPI = new OpenAPIParser()
.readLocation("src/test/resources/3_0/spring/form-requestbody-params-with-constraints.yaml", null, new ParseOptions()).getOpenAPI();
SpringCodegen codegen = new SpringCodegen();
codegen.setLibrary(SPRING_BOOT);
codegen.setOutputDir(output.getAbsolutePath());
codegen.additionalProperties().put(SpringCodegen.INTERFACE_ONLY, "true");
codegen.additionalProperties().put(SpringCodegen.USE_BEANVALIDATION, "true");
codegen.additionalProperties().put(CodegenConstants.MODEL_PACKAGE, "xyz.model");
codegen.additionalProperties().put(CodegenConstants.API_PACKAGE, "xyz.controller");

ClientOptInput input = new ClientOptInput()
.openAPI(openAPI)
.config(codegen);

DefaultGenerator generator = new DefaultGenerator();
generator.setGenerateMetadata(false);
Map<String, File> files = generator.opts(input).generate().stream()
.collect(Collectors.toMap(File::getName, Function.identity()));

JavaFileAssert.assertThat(files.get("AddApi.java"))
.assertMethod("addPost")
.assertParameter("name")
.assertParameterAnnotations()
.containsWithNameAndAttributes("Pattern", ImmutableMap.of("regexp", "\"^[[:print:]]+$\""))
.toParameter()
.toMethod()
.assertParameter("quantity")
.assertParameterAnnotations()
.containsWithNameAndAttributes("Min", ImmutableMap.of("value", "1"));
}

@Test
public void shouldHandleSeparatelyInterfaceAndModelAdditionalAnnotations() throws IOException {
File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
Expand Down
32 changes: 32 additions & 0 deletions ...api-generator/src/test/resources/3_0/spring/form-requestbody-params-with-constraints.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
openapi: 3.0.1
info:
title: Test form
version: 1.0.0
servers:
- url: https://where.am.i
paths:
/add:
post:
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
required:
- id
- quantity
properties:
name:
type: string
pattern: '^[[:print:]]+$'
quantity:
type: integer
minimum: 1
responses:
'200':
description: OK
content:
application/json:
schema:
type: boolean
16 changes: 8 additions & 8 deletions ...client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/FakeApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,19 +324,19 @@ ResponseEntity<Client> testClientModel(
)

ResponseEntity<Void> testEndpointParameters(
@Parameter(name = "number", description = "None", required = true) @Valid @RequestParam(value = "number", required = true) BigDecimal number,
@Parameter(name = "double", description = "None", required = true) @Valid @RequestParam(value = "double", required = true) Double _double,
@Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@Parameter(name = "number", description = "None", required = true) @DecimalMin("32.1") @DecimalMax("543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number,
@Parameter(name = "double", description = "None", required = true) @DecimalMin("67.8") @DecimalMax("123.4") @Valid @RequestParam(value = "double", required = true) Double _double,
@Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte,
@Parameter(name = "integer", description = "None") @Valid @RequestParam(value = "integer", required = false) Integer integer,
@Parameter(name = "int32", description = "None") @Valid @RequestParam(value = "int32", required = false) Integer int32,
@Parameter(name = "integer", description = "None") @Min(10) @Max(100) @Valid @RequestParam(value = "integer", required = false) Integer integer,
@Parameter(name = "int32", description = "None") @Min(20) @Max(200) @Valid @RequestParam(value = "int32", required = false) Integer int32,
@Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64,
@Parameter(name = "float", description = "None") @Valid @RequestParam(value = "float", required = false) Float _float,
@Parameter(name = "string", description = "None") @Valid @RequestParam(value = "string", required = false) String string,
@Parameter(name = "float", description = "None") @DecimalMax("987.6") @Valid @RequestParam(value = "float", required = false) Float _float,
@Parameter(name = "string", description = "None") @Pattern(regexp = "/[a-z]/i") @Valid @RequestParam(value = "string", required = false) String string,
@Parameter(name = "binary", description = "None") @RequestPart(value = "binary", required = false) MultipartFile binary,
@Parameter(name = "date", description = "None") @Valid @RequestParam(value = "date", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate date,
@Parameter(name = "dateTime", description = "None") @Valid @RequestParam(value = "dateTime", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) OffsetDateTime dateTime,
@Parameter(name = "password", description = "None") @Valid @RequestParam(value = "password", required = false) String password,
@Parameter(name = "password", description = "None") @Size(min = 10, max = 64) @Valid @RequestParam(value = "password", required = false) String password,
@Parameter(name = "callback", description = "None") @Valid @RequestParam(value = "callback", required = false) String paramCallback
);

Expand Down
16 changes: 8 additions & 8 deletions ...napi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,19 +371,19 @@ default ResponseEntity<Client> testClientModel(
)

default ResponseEntity<Void> testEndpointParameters(
@Parameter(name = "number", description = "None", required = true) @Valid @RequestParam(value = "number", required = true) BigDecimal number,
@Parameter(name = "double", description = "None", required = true) @Valid @RequestParam(value = "double", required = true) Double _double,
@Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@Parameter(name = "number", description = "None", required = true) @DecimalMin("32.1") @DecimalMax("543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number,
@Parameter(name = "double", description = "None", required = true) @DecimalMin("67.8") @DecimalMax("123.4") @Valid @RequestParam(value = "double", required = true) Double _double,
@Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte,
@Parameter(name = "integer", description = "None") @Valid @RequestParam(value = "integer", required = false) Integer integer,
@Parameter(name = "int32", description = "None") @Valid @RequestParam(value = "int32", required = false) Integer int32,
@Parameter(name = "integer", description = "None") @Min(10) @Max(100) @Valid @RequestParam(value = "integer", required = false) Integer integer,
@Parameter(name = "int32", description = "None") @Min(20) @Max(200) @Valid @RequestParam(value = "int32", required = false) Integer int32,
@Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64,
@Parameter(name = "float", description = "None") @Valid @RequestParam(value = "float", required = false) Float _float,
@Parameter(name = "string", description = "None") @Valid @RequestParam(value = "string", required = false) String string,
@Parameter(name = "float", description = "None") @DecimalMax("987.6") @Valid @RequestParam(value = "float", required = false) Float _float,
@Parameter(name = "string", description = "None") @Pattern(regexp = "/[a-z]/i") @Valid @RequestParam(value = "string", required = false) String string,
@Parameter(name = "binary", description = "None") @RequestPart(value = "binary", required = false) MultipartFile binary,
@Parameter(name = "date", description = "None") @Valid @RequestParam(value = "date", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate date,
@Parameter(name = "dateTime", description = "None") @Valid @RequestParam(value = "dateTime", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) OffsetDateTime dateTime,
@Parameter(name = "password", description = "None") @Valid @RequestParam(value = "password", required = false) String password,
@Parameter(name = "password", description = "None") @Size(min = 10, max = 64) @Valid @RequestParam(value = "password", required = false) String password,
@Parameter(name = "callback", description = "None") @Valid @RequestParam(value = "callback", required = false) String paramCallback
) {
return getDelegate().testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback);
Expand Down
16 changes: 8 additions & 8 deletions ...erver/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/FakeApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,19 +411,19 @@ default ResponseEntity<Client> testClientModel(
)

default ResponseEntity<Void> testEndpointParameters(
@Parameter(name = "number", description = "None", required = true) @Valid @RequestParam(value = "number", required = true) BigDecimal number,
@Parameter(name = "double", description = "None", required = true) @Valid @RequestParam(value = "double", required = true) Double _double,
@Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@Parameter(name = "number", description = "None", required = true) @DecimalMin("32.1") @DecimalMax("543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number,
@Parameter(name = "double", description = "None", required = true) @DecimalMin("67.8") @DecimalMax("123.4") @Valid @RequestParam(value = "double", required = true) Double _double,
@Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte,
@Parameter(name = "integer", description = "None") @Valid @RequestParam(value = "integer", required = false) Integer integer,
@Parameter(name = "int32", description = "None") @Valid @RequestParam(value = "int32", required = false) Integer int32,
@Parameter(name = "integer", description = "None") @Min(10) @Max(100) @Valid @RequestParam(value = "integer", required = false) Integer integer,
@Parameter(name = "int32", description = "None") @Min(20) @Max(200) @Valid @RequestParam(value = "int32", required = false) Integer int32,
@Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64,
@Parameter(name = "float", description = "None") @Valid @RequestParam(value = "float", required = false) Float _float,
@Parameter(name = "string", description = "None") @Valid @RequestParam(value = "string", required = false) String string,
@Parameter(name = "float", description = "None") @DecimalMax("987.6") @Valid @RequestParam(value = "float", required = false) Float _float,
@Parameter(name = "string", description = "None") @Pattern(regexp = "/[a-z]/i") @Valid @RequestParam(value = "string", required = false) String string,
@Parameter(name = "binary", description = "None") @RequestPart(value = "binary", required = false) MultipartFile binary,
@Parameter(name = "date", description = "None") @Valid @RequestParam(value = "date", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate date,
@Parameter(name = "dateTime", description = "None") @Valid @RequestParam(value = "dateTime", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) OffsetDateTime dateTime,
@Parameter(name = "password", description = "None") @Valid @RequestParam(value = "password", required = false) String password,
@Parameter(name = "password", description = "None") @Size(min = 10, max = 64) @Valid @RequestParam(value = "password", required = false) String password,
@Parameter(name = "callback", description = "None") @Valid @RequestParam(value = "callback", required = false) String paramCallback
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
Expand Down
16 changes: 8 additions & 8 deletions ...-boot-defaultInterface-unhandledException/src/main/java/org/openapitools/api/FakeApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,19 +353,19 @@ ResponseEntity<Client> testClientModel(
)

ResponseEntity<Void> testEndpointParameters(
@Parameter(name = "number", description = "None", required = true) @Valid @RequestParam(value = "number", required = true) BigDecimal number,
@Parameter(name = "double", description = "None", required = true) @Valid @RequestParam(value = "double", required = true) Double _double,
@Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@Parameter(name = "number", description = "None", required = true) @DecimalMin("32.1") @DecimalMax("543.2") @Valid @RequestParam(value = "number", required = true) BigDecimal number,
@Parameter(name = "double", description = "None", required = true) @DecimalMin("67.8") @DecimalMax("123.4") @Valid @RequestParam(value = "double", required = true) Double _double,
@Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Pattern(regexp = "^[A-Z].*") @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte,
@Parameter(name = "integer", description = "None") @Valid @RequestParam(value = "integer", required = false) Integer integer,
@Parameter(name = "int32", description = "None") @Valid @RequestParam(value = "int32", required = false) Integer int32,
@Parameter(name = "integer", description = "None") @Min(10) @Max(100) @Valid @RequestParam(value = "integer", required = false) Integer integer,
@Parameter(name = "int32", description = "None") @Min(20) @Max(200) @Valid @RequestParam(value = "int32", required = false) Integer int32,
@Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64,
@Parameter(name = "float", description = "None") @Valid @RequestParam(value = "float", required = false) Float _float,
@Parameter(name = "string", description = "None") @Valid @RequestParam(value = "string", required = false) String string,
@Parameter(name = "float", description = "None") @DecimalMax("987.6") @Valid @RequestParam(value = "float", required = false) Float _float,
@Parameter(name = "string", description = "None") @Pattern(regexp = "/[a-z]/i") @Valid @RequestParam(value = "string", required = false) String string,
@Parameter(name = "binary", description = "None") @RequestPart(value = "binary", required = false) MultipartFile binary,
@Parameter(name = "date", description = "None") @Valid @RequestParam(value = "date", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate date,
@Parameter(name = "dateTime", description = "None") @Valid @RequestParam(value = "dateTime", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) OffsetDateTime dateTime,
@Parameter(name = "password", description = "None") @Valid @RequestParam(value = "password", required = false) String password,
@Parameter(name = "password", description = "None") @Size(min = 10, max = 64) @Valid @RequestParam(value = "password", required = false) String password,
@Parameter(name = "callback", description = "None") @Valid @RequestParam(value = "callback", required = false) String paramCallback
) throws Exception;

Expand Down
Loading
Loading