Extract parameters from parameter object

[zarebski-m]

Fixes #120, #268, #162, #119

This PR introduces a new Springdoc annotation org.springdoc.api.annotations.ParameterObject. Request parameter annotated with it are not added as a request parameter themselves, but rather each field of the parameter is added as a separate request parameter. This is compatible with Spring MVC request parameters mapping to POJO object.

See test case 102 in springdoc-openapi-webmvc-core.

Consider the following classes:

class QueryParams {
    private String name;
    private String value;
}

@RestController
class TestController {
    @GetMapping("pojo-params")
    public void testMethod(@ParameterObject QueryParams queryParams) {}
}

In generated docs, the /pojo-params endpoint defines two request parameters: name and value, instead of single queryParams one.

This also allows deprecation of the workaround for Pageable with PageableAsQueryParam annotation – we can simply use @ParameterObject Pageable pageable on method parameter.

See test case 7 on springdoc-openapi-data-rest.

[bnasslahsen]

Hi @zarebski-m,

Thank for sharing your work and your contribution.

Can you please respect the contribution guide and especially formatter provided: Please don't add brackets if there is one instruction, especially on existing instructions:

• https://github.com/springdoc/springdoc-openapi/blob/master/CONTRIBUTING.adoc

You can make sure, you change only the lines related to your feature on the follwoing files: AdditionalModelsConverter, AbstractRequestBuilder.

[zarebski-m]

Thank you, I've applied https://github.com/spring-projects/spring-boot/blob/master/idea/codeStyleConfig.xml to my IDE and reformatted my code.

[bnasslahsen]

Thank you @zarebski-m for your contribution.
Its now merged with master.

[prondzyn]

@bnasslahsen when are you planning to release this feature?

[bnasslahsen]

@prondzyn ,

Should be available, no later than next Monday, 06th April.

[destebanm]

HI!!

Thanks for the new annotation @ParameterObject!

Nevertheless, we are facing an issue when using it. Every attribute of the POJO is being set as required. Is there any way to avoid that?
We are using:
<swagger-annotations.version>2.1.2</swagger-annotations.version>
<springdoc-openapi-ui.version>1.3.1</springdoc-openapi-ui.version>

EDIT: using @Nullable fix the problem, so @Parameter i guess is not supported

Thanks!

[bnasslahsen]

@destebanm,

This is already fixed. #541.
You can just use v1.3.2.

[destebanm]

WOW, it is working fine with 1.3.2!

Thanks!

[dmittriy13]

Hi, thanks for your work, I ran into a problem: inherited fields are not processed.

Here is an example of how to handle this case.
I would be very grateful if you correct this in the next version.

[Ichigo85]

+1
I also need inheritance working for method parameters.

[bnasslahsen]

@Ichigo85,

Its already released. You can use v1.3.6.