Description
Describe the bug
In a Spring Boot RestController that wants to support POST request bodies of both form data or JSON,
to use the built-in functionality, multiple endpoint methods must be used to support both content types.
The JSON accepting method expects the Spring MVC @RequestBody annotation to be used,
while the form data version expects Spring MVC @RequestBody to not be used, so the Swagger annotation must be used instead.
Although the output OpenAPI JSON correctly puts the two as the same request body with different supported content, the operationId is incorrectly deduplicated, changing its value.
n.b. This does require the operationId to be set explicitly on both methods, because otherwise the last automatically generated operationId will be picked to represent both methods.
To Reproduce
- What version of spring-boot you are using?
3.3.1 - What modules and versions of springdoc-openapi are you using?
springdoc-openapi-starter-webmvc-api version 2.6.0,
creating OpenAPI version 3.0.1 JSON. - What is the actual and the expected result using OpenAPI Description (yml or json)?
Actual (snippet):
"post": {
"tags": [
"books"
],
"operationId": "create_1_1",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Book"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Book"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
}
}Expected the same except:
"operationId": "create",- Provide with a sample code (HelloController) or Test that reproduces the problem
@RestController
@RequestMapping("books")
public class DemoController {
@PostMapping(value = "/book", consumes = APPLICATION_JSON_VALUE)
@Operation(operationId = "create", tags = "books")
public void createBookFromJson(
@org.springframework.web.bind.annotation.RequestBody Book book) {
System.out.println("creating book: " + book);
}
@PostMapping(value = "/book", consumes = APPLICATION_FORM_URLENCODED_VALUE)
@Operation(operationId = "create", tags = "books")
public void createBookFromFormData(
@io.swagger.v3.oas.annotations.parameters.RequestBody(required = true) Book book) {
createBookFromJson(book);
}
record Book(@NotNull String title, @NotNull String author) {}
}Expected behavior
- When the different content types are merged for a single requestBody, this should not trigger deduplication and the originally specified operationId should be used.