OpenAPITools / OpenAPITools/openapi-generator

[REQ] Need to add Page<T> support for SpringBoot WebFlux paginated responses

Open
#12,859 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

Need to provide example how to create yaml for org.springframework.data.domain.Page<T> generic type.

Describe the solution you'd like

Client can provide desired class as a refence, but code generator need to support signature: Mono<ResponseEntity<Page<T>>>

Describe alternatives you've considered

I extended PageIml for now, it enforce me to create fake ClientPage class

Additional context

Need better support for WebFlux paginated responses from openapi

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the SpringBoot WebFlux response-generation entry point and the handling of org.springframework.data.domain.Page. Compare the generated output with the requested Mono<ResponseEntity<Page>> signature and the existing PageImpl workaround. Done means an OpenAPI YAML example can generate the desired paginated response without a fake ClientPage class.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring-boot
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.