Created by: tofi86
This PR solves the issue #8315.
When using x-spring-paginated
with the spring
or java-camel
generator, Pageable
is generated as an additional controller argument.
Spring Data Pageable
is designed to consume the query paramters page
, size
and sort
during request handling as described here or here.
When following an API first development pattern, you would usually specify these query parameters in the spec which results in a controller method like the following:
public ResponseEntity<List<Model>> getAllModels(Integer page, Integer size, String sort, Pageable pageable) {
...
}
While this approach and the spec is correct, this is normally not what you want to have as a Spring developer. You'd prefer just the Pageable
controller argument, as the original values of the query params can be retrieved from it:
public ResponseEntity<List<Model>> getAllModels(Pageable pageable) {
int page = pageable.getPageNumber();
int size = pageable.getPageSize();
Sort sort = pageable.getSort();
}
This PR does exactly this - it removes the page
, size
and sort
query params when x-spring-paginated
is used with the spring
or java-camel
generator and Pageable
is generated.
PR checklist
-
Read the contribution guidelines. -
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community. -
Run the following to build the project and update samples: ./mvnw clean package ./bin/generate-samples.sh ./bin/utils/export_docs_generators.sh
./bin/generate-samples.sh bin/configs/java*
. For Windows users, please run the script in Git BASH. -
File the PR against the correct branch: master
(6.3.0) (minor release - breaking changes with fallbacks),7.0.x
(breaking changes without fallbacks) -
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09)